A service for storing and analyzing a user's financial habits.
The app is live on Heroku.
Copy the file .env.example
as .env
and edit it to match your environment settings.
Requires:
Run docker-compose up
from the root of the project.
This will spin up an app server, a postgres service and seed the database with dummy data.
The entry point of the service is available on http://localhost:3000/api
Requires:
From the root directory of the project, run:
$ bundle install
$ bundle exec rake db:setup
$ bundle exec rake db:seed
$ bundle exec rake server
The service should now be available on http://localhost:3000/api
Run bundle exec rake
from the root of the project.
The app is bundled with a task for stepping inside its environment.
Run bundle exec rake console
from the root directory.
To print out all available endpoints, run the task 'bundle exec rake routes'
$ bundle exec rake routes
GET /api/movies
POST /api/movies
GET /api/reservations
POST /api/reservations
GET /api/swagger_doc
GET /api/swagger_doc/:name
The API's entry point (/api
) will show the app's endpoints.
The API documentation is available on http://localhost:3000/api/swagger_doc
once the service is running, or live on Heroku.
To explore the API, paste the document on Swagger Editor.