Simple API that has basic CRUD operations (Create, Read, Update, and Delete) for managing a to-do list.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Also, You need to read the API Documentation.
- Download and install Nodejs
- Download and install PostgreSQL & How to install it using Docker from Docker Hub
- A web browser (e.g. Google Chrome, Mozilla Firefox, Microsoft Edge)
- A text editor (e.g. Visual Studio Code, Sublime Text)
- A platform for testing APIs like Postman
- Database engine (e.g DBeaver, DataGrip)
- Clone the repository to your local machine:
https://github.com/MuhammedMagdyy/Todo-List-API.git
- Install required packages
npm install
- Configure the environment variables, such as the database URL.
npm run build
thennpm run start
or usenpm run dev
.
- TypeScript
- Nodejs
- Express.js
- PostgreSQL
- Prisma (ORM)