TODO API

Project   |    Technologies   |    Services Used   |    Getting Started   |    How To Use   |    Features   |    License

💻 Project

TODO API is an application to create online tasks. This project is a template for a challenge proposed in the NodeJS track of IGNITE (Rocketseat Career Acceleration Program).

The tests were developed by Rocketseat.

🚀 Technologies

This project was developed using these techs:

• Node.js
• Express
• Javascript
• Jest

👨‍🔧 Services Used

• GitHub

🎮 Getting Started

If you want run this code, you can start cloning the repository using HTTP or SSH key.

• Open your git

• Type git clone

• Insert the HTTP or SSH key (on windows, shift + insert to paste on gitBash)

• You can find this HTTP or SSH Key by clicking on Code on the top right in this repository

• Once cloned you can open the project in your IDE and enter the codes below in the IDE terminal

yarn To add the dependencies on the project.

yarn dev Runs the app in the development mode.
Open http://localhost:3333 to view it in the browser.

You can use Insomnia (or other similar tool) to test the application's routes.

Dependencies

• Express
• uuid

Dev Dependencies

• Nodemon
• Jest
• SuperTest

📌 How to Use

1 - Open the aplication on your IDE

2 - Run yarn dev on your IDE terminal

3 - Use Insomnia to test the application's routes or run yarn test to test application routes with JEST & SuperTest

🕵 Features

The main features of the application are:

• Create a user;
• List all user TODOs;
• Create a task;
• Change the title and deadline of the task;
• Mark a task as done;
• Delete a task;

Business rules

• It's not possible to create a user with the same username
• It's not possible to list all tasks for a non-existent username
• It's not possible to create a task for a non-existent username
• It's not possible to change the title and deadline of a non-existent task
• It's not possible to mark a non-existent task as done
• It's not possible to delete a non-existent task

📝 License

This project is under MIT license.

In case of sensitive bugs like security vulnerabilities, please contact deywerson.pereira@gmail.com directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!

---

Please follow on github and join us! Thanks for visiting me and good coding!

Made with ♥ by Deywerson Pereira