Todo Backend

Check out the frontend repository for this project on Github: Todo Frontend

• Mysql Database Service

1. Clone this repository to your local machine.
2. Open the terminal in the repository directory.
3. Install the packages:

npm install

4. Create .env file in the root folder and copy paste the content of .env.sample, and add necessary credentials.
5. To start project in development run

npm run dev

6. To start project in production run

# To comiple ts
npm run tsc
# To run app using nodejs
npm run start

7. Before commit run

# To beautify the code formatting
npm run lint

• The project insures that the server only starts after database is connected and working properly.

• Project uses typescript for es6 and type safety but in package.json and tsconfig.json files "type"(package.json) and "module"(tsconfig.json) properties are set to "commonjs" so that project can use some packages that can only be used with "commonjs".

• Express for building APIs.
• CORS to allow multiple origins
• Dotenv to hide sensitive information.
• TypeScript for type safety.
• ts-node-dev for restarting server in development mode.
• Sequelize as an ORM for working with databases.
• Git for version control and collaborative development.

Contributions are welcome! If you have any improvements, or bug fixes, feel free to submit a pull request.

This project is licensed under the MIT License. See the LICENSE file for details.

For any inquiries or feedback, please reach out to us using the following email addresses:

@ChiragWadhwani05: [email protected]

@LakshayManglani: [email protected]