MCP Servers

Running the Project with Docker

This project is containerized using Docker and Docker Compose, with separate services for the Python backend (FastAPI), JavaScript frontend (served by Node.js/serve), and a PostgreSQL database. Below are the project-specific instructions and requirements for running the application.

Project-Specific Docker Requirements

• Backend

  • Python 3.11 (slim image)
  • System dependencies: gcc, libpq-dev, build-essential (for psycopg2 and other packages)
  • All Python dependencies are installed from requirements.txt in a virtual environment
  • Runs as a non-root user (appuser)
  • Exposes port 8000 (FastAPI)

• Frontend

  • Node.js 22.13.1 (alpine) for serving static files with the serve package
  • All static files (including gallery/ and project images/ folders) must be inside the frontend/ directory before building
  • Exposes port 80 (served by serve)

• Database

  • PostgreSQL (official image, version 15 recommended)
  • Initializes schema from ./db/schema.sql (includes both manufacturing_events and machines_info tables)
  • Exposes PostgreSQL port 5132 on the host (mapped to 5432 in the container)
  • Uses a named volume postgres-data for persistent storage

Environment Variables

• PostgreSQL (set in compose.yaml):
  • POSTGRES_USER=postgres
  • POSTGRES_PASSWORD=postgres
  • POSTGRES_DB=postgres
• Backend: Uses the DATABASE_URL environment variable, set automatically by Docker Compose for container-to-container communication.
• Frontend: No required environment variables by default. If you need to add any, uncomment the env_file lines in the compose file and provide a .env file in the respective directory.

Build and Run Instructions

1. Ensure Docker and Docker Compose are installed.
2. From the project root, run:

   docker compose up --build
   

   This will build and start all services: backend, frontend, and database.

Ports Exposed

• Backend (FastAPI): http://localhost:8000
• Frontend (Static): http://localhost (served on port 80)
• PostgreSQL: Host port 5132 (for local tools, containers use service name postgres-db)

Static Assets (Images, etc.)

• Place all images and static assets (e.g., gallery/, project images/) inside the frontend/ directory before building the Docker image.
• Reference images in your HTML/CSS/JS using paths like /gallery/your-image.jpg or /project images/your-image.png.
• The static server will serve these from the root, so /gallery/... and /project images/... will work as expected.

Special Configuration

• The backend and frontend services are built from their respective directories using custom Dockerfiles.
• The backend uses a Python virtual environment for dependencies and runs as a non-root user.
• The frontend is served by Node.js using the serve package, not Nginx.
• The database schema is automatically initialized from ./db/schema.sql on first run (includes both main tables).
• All services are connected via a custom Docker network (app-network).
• Persistent database storage is handled via the postgres-data Docker volume.

Note: If you need to provide environment variables to the backend or frontend, create a .env file in the respective directory and uncomment the env_file line in the compose file.