bookio / server-old

2 stars 0 forks source link

Server repository needs documentation #10

Open javidgon opened 10 years ago

javidgon commented 10 years ago

As a developer, It'd be really helpful to rely on a documentation in case of doubts or questions.

This documentation could consist in a README file with the global picture (repo structure, milestones, architecture, TODOs...some diagrams would be helpful as well), a API definition that the client should implement in order to consume the REST resources, and finally, the instructions for deploying the server both locally and in production (Heroku).