This project is a Task Manager application that provides a web API for managing TODO items. It includes both a frontend and a backend component.
[ https://github.com/savio1-domi/task_manager ]
To set up the project, follow these steps:
git clone [email protected]:savio1-domi/task-manager.git
cd Task-Manager
npm install
git clone [email protected]:savio1-domi/phase-3-sinatra-react-project.git
bundle install
rake db:migrate
To run the application, execute the following command in the backend repository:
rake start
Then, open the application from your browser http://localhost:9292
The Task Manager application provides the following features:
- User Authentication: Users can register a new account and log in to an existing account.
- TODO Management: Users can create, update, and delete TODO items.
- TODO Filtering: Users can view all TODO items and filter them by status.
The backend API supports the following endpoints:
-
/register
: Create a new user account.(POST request)Request Body:
{ "name": "John Doe", "email": "[email protected]", "password": "12345678", "confirm password": "12345678", "phone_number": "0712345678" }
-
/credentials
: Log in a user using email and password. (POST request)Request Body:
{ "email": "[email protected]", "password": "12345678" }
-
/post
: Add a new TODO item. (POST request)Request Body:
{ "name": "Make Breakfast", "description": "Prepare milk and cereal", "category": "meal" }
-
/all
: List all TODO items. (GET request)Response Sample:
{ "data": [ {"id": 2, "name": "last", "description": "esgdh", "category_id": 2, "created_at": "2023-03-05T19:49:48.112Z", ...}, {"id": 1, "name": "first", "description": "sgdgf", "category_id": 1, "created_at": "2023-03-05T19:49:19.600Z", ...} ], "message": "SUCCESS" }
-
/patch/:id
: Update an existing TODO. (PATCH request) -
/delete/:id
: Delete a TODO item. (DELETE request)
If you would like to contribute to the project, follow these guidelines:
- Report any issues or bugs by creating a new issue on the GitHub repository.
- Submit feature requests or suggestions by creating a new issue on the GitHub repository.
- Follow the development setup instructions in the repository's README.
- Adhere to the coding conventions and guidelines specified in the repository.
- Write clear commit messages and submit pull requests for review.
This project is licensed under the Learn.co Educational Content License. By contributing to this project, you agree to license your contributions under the same license.