Skip to content

skirt-owner/todo-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TODO (Backend)

TODO is a backend application that provides APIs for managing todos.

Installation

To get started with TODO, follow these steps:

  1. Clone the repository:
git clone [repository URL]
  1. Install the dependencies:
npm install

Getting Started

Before running the application, make sure you have set up the following:

  1. Configure the database connection in the .env file.
  2. Run the database migrations:
npx sequelize-cli db:migrate 

To start the application, use the following command:

npm start

API Documentation

The API documentation can be found in the API Documentation file. It contains detailed information about each API endpoint, request formats, and response formats.

Technologies Used

Node.js
Express.js
Sequelize
PostgreSQL

Project Structure

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.

License

This project is licensed under the MIT License.

Contact

For any inquiries or questions, feel free to contact me or reach out on Telegram.

About

Backend for a TODO project.

Resources

License

Stars

Watchers

Forks