API Project

This project is a FastAPI application with a PostgreSQL database, running entirely in Docker.

Table of Contents

• Requirements
• Setup
• Running the Project
• Accessing the Database
• Docker Notes
• Project Structure

---

Requirements

• Docker
• Docker Compose
• Optional: psql client (if you want to connect from host machine)

---

Setup

1. Clone the repository:

git clone https://github.com/PR202111/Apis.git
cd Apis

2. Build and start the containers:

docker-compose up --build

This will start:

• api-api (FastAPI server)
• api-db (PostgreSQL database)

---

Running the Project

Once the containers are running:

• FastAPI server: http://localhost:8000
• It will automatically reload on code changes.

You can stop the containers with:

docker-compose down

---

Accessing the Database

From inside the API container:

docker exec -it api-api bash
psql -h api-db -U postgres -d mydatabase

From your local machine (optional, requires port mapping):

psql -h localhost -U postgres -d mydatabase

Tables:

\dt;

Sample query:

SELECT * FROM users;

---

Docker Notes

• Containers communicate using Docker network, using service names (like api-db) as hostnames.
• Port mapping (5432:5432) is only needed if you want to access Postgres from your host machine.
• Database initialization is handled automatically on first startup.

---

Project Structure

.
├── app/                # FastAPI application code
├── Dockerfile
├── docker-compose.yml
├── requirements.txt
└── README.md

---