TODO is a backend application that provides APIs for managing todos.
To get started with TODO, follow these steps:
- Clone the repository:
git clone [repository URL]
- Install the dependencies:
npm install
Before running the application, make sure you have set up the following:
- Configure the database connection in the .env file.
- Run the database migrations:
npx sequelize-cli db:migrate
To start the application, use the following command:
npm start
The API documentation can be found in the API Documentation file. It contains detailed information about each API endpoint, request formats, and response formats.
The project follows a standard structure:
src
├── controllers
| └── todoControllers.js
├── middlewares
| ├── morgan.middleware.js
| ├── requestId.middleware.js
| └── responseTime.middleware.js
├── models
| ├── Todo.js
| └── Tag.js
├── routes
| └── todoRoutes.js
├── utils
| ├── database.js
| ├── dotenv.js
| └── logger.js
└── app.js
- controllers: Contains the controllers for each route.
- models: Contains the database models.
- routes: Contains the route definitions.
- utils: Contains the utility files such as database connection and logger.
- app.js: Entry point of the application.
This project is licensed under the MIT License.
For any inquiries or questions, feel free to contact me or reach out on Telegram.