Skip to content

MuhammedMagdyy/Todo-List-API

Repository files navigation

Todo List

Simple API that has basic CRUD operations (Create, Read, Update, and Delete) for managing a to-do list.

Getting started

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.

Prerequisites

  • 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)

Installing

  1. Clone the repository to your local machine:
https://github.com/MuhammedMagdyy/Todo-List-API.git
  1. Install required packages npm install
  2. Configure the environment variables, such as the database URL.
  3. npm run build then npm run start or use npm run dev.

Tools & Technologies

  • TypeScript
  • Nodejs
    • Express.js
  • PostgreSQL
  • Prisma (ORM)

Releases

No releases published

Packages

No packages published