This README would normally document whatever steps are necessary to get the application up and running.
We are currently exploring the use of Application Programming Interfaces (APIs) in our class. After working with databases (such a sequel and sqlite3) and practicing pairing these databases with created servers (such as webrick and sinatra) to create basic websites, we have now moved onto using ruby on rails. This is my first attempt at creating an API in Rails. I will be following closely along with the Rails tutorial. As I expand my knowledge of rails, I will be using this project as a playground of sorts to try out many ideas and concepts.
Things you may want to cover:
- Ruby version
This application runs in ruby 2.4.1
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...