rovor-api
This is a JSON RESTful API meant to save alerts created by users, provide alerts to the crawler, save deals found by the crawler(s), and provide deals to rovor.io to be emailed to users.
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
-
...