diff --git a/README.md b/README.md index 2fbf185..dd0b46e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# Lizardboard - An open source clone of [geckoboard](https://www.geckoboard.com/). Interested in contributing? Take a look at the [project page](https://github.com/GuildCrafts/lizardboard/projects) and [issues page](https://github.com/GuildCrafts/lizardboard/issues) for outstanding issues. ## Contributing to Lizardboard @@ -14,6 +12,21 @@ A mongodb database named lizardboard must be created prior to starting the appli - Ensure `mongo` is running - yarn install +## HTTP API +description | CRUD | verb | path | +-------------------------------------------- | ------ | ------ | ---------------------------------------- | +Show all users | read | get | /api/v1/users | +Create new user | create | post | /api/v1/users | +Show user by ID | read | get | /api/v1/users/:id | +Update user by ID | update | put | /api/v1/users/:id | +Delete user by ID | delete | delete | /api/v1/users/:id | +Show all dashboards | read | get | /api/v1/dashboards | +Create a dashboard | create | post | /api/v1/dashboards | +Show a dashboard by ID | read | get | /api/v1/dashboards/:id | +Update dashboard by ID | update | put | /api/v1/dashboards/:id | +Delete dashboard by ID | delete | post | /api/v1/dashboards/:id | +Create new widget and push into dashboard | create | post | /api/v1/dashboards/:id/widgets | + ## Technical Stack ### Back End @@ -24,11 +37,10 @@ A mongodb database named lizardboard must be created prior to starting the appli ### Database - [Mongodb](https://docs.mongodb.com/) - -[Mongoose](http://mongoosejs.com/docs/guide.html) - -[Migrate-Mongoose](https://github.com/balmasi/migrate-mongoose) +- [Mongoose](http://mongoosejs.com/docs/guide.html) -## Front End +### Front End - [React](https://facebook.github.io/react/) -## Testing -TBD \ No newline at end of file +### Testing +TBD