https://github.com/manthan0x23/todo-api
A docker postgres and typescript implementation for a simple todo app
https://github.com/manthan0x23/todo-api
docker docker-compose express postgresql typescript
Last synced: 3 months ago
JSON representation
A docker postgres and typescript implementation for a simple todo app
- Host: GitHub
- URL: https://github.com/manthan0x23/todo-api
- Owner: manthan0x23
- Created: 2023-12-29T12:24:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T14:44:03.000Z (over 2 years ago)
- Last Synced: 2025-06-05T08:02:00.308Z (about 1 year ago)
- Topics: docker, docker-compose, express, postgresql, typescript
- Language: TypeScript
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Simple Todo App Implementation with Docker
This repository contains a basic Todo App with API endpoints for user and to-do operations. The application is set up to run in a Docker environment for easy deployment. Follow the steps below to reproduce the environment locally.
## Steps to Reproduce
1\. **Clone the Repository:**
```bash
git clone https://github.com/manthan-sharma-23/todo-api.git
cd ./todo-api
```
2\. **Run Docker Compose:**
Use Docker Compose to install dependencies, set up a PostgreSQL database, and run the app instance locally.
```bash
docker compose up
```
3\. **Access the App:**
The application should now be running, and you can access it at [http://localhost:3200](http://localhost:3200).
## API Endpoints
**Postman Workspace:** https://documenter.getpostman.com/view/26738295/2s9YsDjEYA
## Running Locally
- Ensure Docker and Docker Compose are installed on your machine.
- Use the provided Docker Compose configuration to set up the environment.
- Access the app at [http://localhost:3200](http://localhost:3200).
Feel free to explore and modify the code to suit your needs. If you encounter any issues or have questions, refer to the repository's documentation or seek support from the project's maintainer.