lucaslombardo / heroku-demo

rails-api-campus-server

This is part of the Rails API sequence of talks. Each talk has its own repository with a reference README.

• Rails API: Single Resource
• Rails API: One-to-Many
• Rails API: Many-to-Many

Each talk is designed to walk through the creation of a real Rails API, feature-by-feature, using "error driven development".

During the sequence, we will be building the following features for this API.

• Library
• Hospital
• Cafeteria

The API contains a few important branches:

• master contains starter code.
• tutorial contains detailed commit history, and tags for where each talk should end.
• solution contains a feature-complete reference API. History is not canonical.

Preparation

1. Fork and clone this repository.
2. Create a new branch, training, for your work.
3. Checkout to the training branch.
4. Install dependencies with bundle install.
5. Create a .env for sensitive settings (touch .env).
6. Generate new development and test secrets (bundle exec rails secret).
7. Store them in .env with keys SECRET_KEY_BASE_<DEVELOPMENT|TEST> respectively.
8. Setup your database with bin/rails [db:drop] db:create db:migrate db:seed.
9. Run the API server with bin/rails server.

Tasks

Developers should run these often!

• bin/rails routes lists the endpoints available in your API.
• bin/rails test runs automated tests.
• bin/rails console opens a REPL that pre-loads the API.
• bin/rails db opens your database client and loads the correct database.
• bin/rails server starts the API.
• scripts/*.sh run various curl commands to test the API. See below.

Additional Resources

• Deploying a Rails API to Heroku
• Rails guides for an API App
• Blog post of building a JSON API with Rails 5

License

1. All content is licensed under a CC­BY­NC­SA 4.0 license.
2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].