Skip to content

Document Lizardboard API(Closes #42) #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Moniarchy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document Lizardboard API(Closes #42) #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Copy link
Contributor

@jrobcodes jrobcodes Nov 18, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just API should be fine here

description | CRUD | verb | path |
-------------------------------------------- | ------ | ------ | ---------------------------------------- |
Show all users | read | get | /api/v1/users |
Copy link
Contributor

@jrobcodes jrobcodes Nov 18, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of nitpicky, but the column title says CRUD, but then entries are listed in RC order here. Can you please order entries in this table consistently (in order CRUD)?

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 |
Copy link
Contributor

@jrobcodes jrobcodes Nov 18, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the Create and Update endpoints, we need to somehow list the expected data and data types, so that users of the API know what they are expected to post/put/etc.

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
Expand All @@ -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
### Testing
TBD