The Splay Backend is the interface between the Splay Controller and the web application, offering RESTapi in order to control the whole application.
- JSON API Specification for building our API
- RuboCop for code analyzer, sanitizer and formatter
- Rspec as our main testing framework
These are the tasks performed and to be performed on Backend
- DB definition and versioning belongs to Backend
- Transform Backend in a small Rails API app
- Immediately setup Rubocop and Rspec
- CircleCI or TravisCI integration
- Recreate DB Schema using migrations
- Tests on models
- API entries for the listed routes in
api.raml - JSON API is tested
This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...
If you launch this component with docker, don't forget to choose a environment variable call MASTER_KEY used to generate secure json web token.