This is the code source of deckie's platform API. This API is written in Ruby with Rails 5.
This API is following the REST architecture and the JSON API specification.
To run, test and deploy this project, please install before Docker 1.8+ and Docker Compose 1.5+ and Make.
N.B. Ruby is not required, the development environment and the API will be run inside linux containers including the proper ruby version.
In foreground:
make up
make worker
make detach
This will run both the API and the job worker inside their own container.
To stop and clean everything after running the whole stack in background:
make clean
make shell
Files inside the container will be synchronised with local files.
You can now type commands like:
bundle exec rake db:migrate
Run the migrations once first:
make migrations
Then:
make test
Not yet implemented.
Deckie API is licensed under the Apache License, Version 2.0. See LICENSE for full license text.