calminer/docs/development_setup.md

Development Setup Guide

Prerequisites

• Python (version 3.10+)
• PostgreSQL (version 13+)
• Git

Database Setup

1. Install PostgreSQL and create a database named calminer.

2. Create schema bricsium_platform:

   CREATE SCHEMA bricsium_platform;
   

3. Load the schema from structure.sql:

   psql -d calminer -f structure.sql
   

Backend Setup

1. Clone the repo.
2. Create a virtual environment: python -m venv .venv
3. Activate it: .venv\Scripts\activate (Windows) or source .venv/bin/activate (Linux/Mac)
4. Install dependencies: pip install -r requirements.txt
5. Set up environment variables (e.g., DB connection string in .env).
6. Run migrations if any.
7. Start server: python main.py or uvicorn main:app --reload

Frontend Setup

(TBD - add when implemented)

Running Locally

• Backend: uvicorn main:app --reload
• Frontend: (TBD)

Testing

• Run tests: pytest