Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hamed-farag/todo-resetful-apis
https://github.com/hamed-farag/todo-resetful-apis
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hamed-farag/todo-resetful-apis
- Owner: hamed-farag
- Created: 2024-01-06T08:28:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-01-07T12:03:10.000Z (11 months ago)
- Last Synced: 2024-01-08T13:02:36.528Z (10 months ago)
- Language: TypeScript
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Todo Reastful APIs
## Introduction
This Todo Application is a simple, yet powerful tool designed to help manage your daily tasks. It's built using Express.js, Prisma, and PostgreSQL, providing a robust backend for handling CRUD operations. Additionally, the app is dockerized for easy setup and deployment.
## Features
- CRUD Operations: **Get by ID**, **Get all items**, **Update**, **Create**, and **Delete** (Soft Delete).
- Docker Setup: Containerized for easy deployment and scalability.
- API Documentation: Accessible through a user-friendly interface (Swagger-UI).
## Requirements
- Docker
- Docker Compose
- Node.js (20.x.x) (for local development)
## Installation and Setup
1- Clone the Repository
```
git clone https://github.com/hamed-farag/todo-resetful-apis.git
```
2- Navigate to the Project Directory
```
cd todo-resetful-apis
```
3- Run Docker Compose:
To build and start the application, use:
```
docker compose up --build
```
## Accessing the Application
- The application will be running at **http://localhost:3000**.
- Access the API documentation at **http://localhost:3000/docs**.