Medium clone web project api
The UI template is hosted here
The Pivotal Tracker is hosted here
The documentation is also hosted here
The project involves bla bla
The application uses Ruby on Rails web framework to build a RESTful Api. Our API will expose the following RESTful endpoints
| Endpoint | Functionality |
|---|---|
| POST/auth/signup | Creates a user account |
| POST/auth/login | Logs in a user |
| GET/auth/logout | Logs out a user |
| PUT/auth/reset-password | Reset a password for a user |
| POST/article | Create a new article |
| POST/articles/article-ID/comment | Create a comment for an article |
| GET/articles | Get all articles |
| GET/articles/id | Get a single article |
| PUT/articles/id | Edit a single article |
| PUT/articles/article-ID/comments/comment-ID | Edit a comment |
This is how you can get a copy of the same on your machine
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
-
...