Skip to content

jcfausto/rails-5-api-exercise

Repository files navigation

Rails 5 API Exercise

This is an API for a Todo application.

This API contains the basics:

  • Run on Docker
  • REST implementation
  • Serialization
  • Authorization and Authentication
    • Authentication service (email and password)
    • Authorization service with JWT
    • Sign up and Login endpoints
  • Pagination
  • Custom error handling
  • Custom concerns and helpers
  • Delete account
  • API versioning
  • Live on Heroku (Entrypoint: https://serene-inlet-37938.herokuapp.com)

API docs available here

Postman documentation

How to run

On Docker

$ docker-compose build
$ docker-compose run api rspec
$ docker-compose up

On Heroku

$ docker-compose build
$ docker run -itP r5todoapi "rspec"
$ heroku container:push web
$ heroku run rake db:migrate
$ heroku open

Stand alone

$ bundle install
$ rake db:create
$ rake db:migrate
$ bundle exec rspec