Your basic To-Do list, but shareable and fun.
- Product Owner: Gabriel Meyr
- Scrum Master: Rokas Zickevicius
- Development Team Members: Oleg Umarov, George Abou-Zolof
- Usage
- [API Endpoints](#Api Endpoints)
- Requirements
- Development
- Team
- Contributing
Creating An Account This can be done from the homepage or at /signup.
Making A List Once you're logged in, you are immediately presented with input fields for a new list. If you navigate to a list you already created then decide to make a new list, simply click the 'New List' button in the sidebar.
Viewing A List After logging in you can see a directory of your lists in the sidebar on the left. Click on a list name to see all the tasks on the list. Click on a task to see details about that task.
Sharing A List, Sub-list, Or Task While viewing a list, click the "Share List" button at the top of the page to share it. Enter the email address of the person you want to share it with and click "Ok!". That person will then be able to use the email to access the list. The list will be added to their user profile (it will remain on your own profile also).
If you are viewing a list and only want to share part of it, then click the checkbox by each task you want to share and then click "Share List". You can share individual tasks by just checking one box or by clicking on a task to view it in detail, then clicking "Share Task".
Deleting A List Click the "Delete List" button when viewing a list to delete the list. You can delete individual tasks from either the list view page or the task view page by clicking the "X" in the top-right corner of the task.
| END POINT | HTTP METHOD | WHAT IT DOES |
|---|---|---|
| /task_lists | GET | return a collection of task lists with IDs and names, but not too much other information |
| /task_lists | POST | create a new task list |
| /task_lists/:id | GET | return task list object for specific ID |
| /task_lists/:id | PUT | update a task list for specific ID |
| /task_lists/:id | DELETE | delete a task list for specific ID |
| /task_lists/:id/tasks | GET | returns a all tasks associated with that list ID |
| /task | GET | return a collection of all tasks (IDs and names, not much else) |
| /task | POST | create new task |
| /task/:id | GET | return task object for specific ID |
| /task/:id | PUT | update a task for specific ID |
| /task/:id | DELETE | delete a task for specific ID |
| /users | GET | return a collection of users (IDs and names, not too much info) |
| /users | POST | create a new user |
| /users/:id | GET | return user object for specific ID |
| /users/:id | PUT | update a user for specific ID |
| /users/:id | DELETE | delete a user for specific ID |
| /users/:id/task_lists | GET | return a task list for a specific user (task IDs and names) |
- Node 0.10.x
- Redis 2.6.x
- Postgresql 9.1.x
- etc
- etc
From within the root directory:
sudo npm install -g bower
npm install
bower installView the project roadmap here
See CONTRIBUTING.md for contribution guidelines.