Git Product home page Git Product logo

rest-api-guide's Introduction

Rails REST API Simple TDD practice

Small TDD driven practice app to build a Rails RESTful API.

  • Contains API controller for : users
  • Includes full rspec test for basic API CURD
  • No authentication features included so far (I plan to have them at a later stage)
  • Intended to be a simple boilerplate for future applications

Technologies used

  • Rails 6.0.3.3
  • Ruby: 2.6.5
  • Postgresql: 1.2.3
  • Factory Bot Rails

Database Requirements

  • The application runs in a development environment with a Postgresql DB
  • Please install pg DB, and create a user/pass for development account.
  • app user pre-configured: devuser
  • It is highly recommended to store you password in an environment variable at login. In a development environment, I use the same password for all my apps. In my case, I have a macOS environment, and I use this command to load the password in the .bash_profile
echo 'export APPNAME_DATABASE_PASSWORD="PostgreSQL_Role_Password"' >> ~/.bash_profile

mode details on how to install and configure your pg database for macOS environments: How To Use PostgreSQL with Your Ruby on Rails Application on macOS

  • Configurations must be hosted @ /config/database.yml

/config/database.yml


  username: devuser
  password: <%= ENV['APPNAME_DATABASE_PASSWORD'] %>

Bundle Installation

  • Clone Repository
  • Run bundle install

Database creation

rails db:create

Database initialization

rails db:migrate

How to run the test suite at project root folder.

/rspec

Authors

๐Ÿ‘ค Carlos Anriquez

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a โญ๏ธ if you like this project!

Acknowledgments

๐Ÿ“ License

This project is MIT licensed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.