kbtanvir/todo-app-v1

Full stack todo app with micro services and docker

Preview

Installation

Prerequisites

Make sure you have the following installed:

• Docker
• Docker Compose

Clone the Repository

git clone https://github.com/kbtanvir/todo-app-v1.git
cd todo-app-v1

Directory Structure

Ensure your directory structure looks like this:

todo-app/
├── client/
│   ├── Dockerfile
│   ├── src
         └── App.tsx
│   ├── features/todo
         └── model.ts
         └── provider.ts
         └── repo.ts
├── server/
│   ├── Dockerfile
│   ├── api
         └── index.py
└── compose.yml

Building and Running the Application

1. Build and Run Docker Compose:

   From the root directory (todo-app/), run the following command to build and start the services defined in docker-compose.yml:

   docker-compose up --build

   This command will build the Docker images for the client and server apps defined in their respective Dockerfiles and start containers for both services.

2. Accessing the Applications in local machine:

   • Client App: Access the React client app in your browser at http://localhost:3000.

   • Server App: The Flask server app with SQLAlchemy will be accessible at http://localhost:5000.

3. Swagger Documentation:

   • Swagger UI: After starting the server, you can access the Swagger UI to view the API documentation at http://localhost:5000/apidocs.

4. Live urls:

   • Client App: live url

   • API Docs: here

Stopping the Application

To stop the Docker containers running the applications, press Ctrl + C in the terminal where docker-compose up is running. This will stop the containers gracefully.

Tech Stack

Backend:

• Python
• Flask
• SQLAlchemy
• Postgress - Live
• Sqlite - Local
• NGINX

Frontend:

• TypeScript
• React with Vite
• Tailwind CSS
• Polystate - State manager
• Zod - Validation
• Docker
• Docker Compose