Documentation - justdoit-api.herokuapp.com.
Source code - https://github.com/andela-bkanyolo/justdoit
You need to install the following:
Clone the application to your local machine:
$ git clone https://github.com/andela-bkanyolo/justdoit.git
Install the dependencies
$ bundle install
Setup database and seed data
$ rake db:setup
To run the application;
$ rails s
To test the application;
$ rspec
It returns JSON only
| Endpoint | Action |
|---|---|
| POST /signup/ | Create a new user |
| POST /auth/login/ | Log in existing user |
| GET /auth/logout/ | Log out existing user |
| POST /bucketlists/ | Create a new bucket list |
| GET /bucketlists/ | List all the created bucket lists |
| GET /bucketlists/{id} | Get single bucket list |
| PUT /bucketlists/{id} | Update this bucket list |
| DELETE /bucketlists/{id} | Delete this single bucket list |
| POST /bucketlists/{bucket_id}/items/ | Create a new item in bucket list |
| GET /bucketlists/{bucket_id}/items | List all the created items in a bucket list |
| GET /bucketlists/{bucket_id}/items/{id} | Get a single item in a bucket list |
| PUT /bucketlists/{bucket_id}/items/{item_id} | Update a bucket list item |
| DELETE /bucketlists/{bucket_id}/items/{item_id} | Delete an item in a bucket list |
- Fork it!
- Create your branch:
git checkout -b ft-awesome - Commit your changes:
- Push to the branch:
git push origin ft-awesome - Submit a pull request