zwitschi
04d7f202b6
Some checks failed
CI / test (pull_request) Failing after 1m8s
- Introduced a new document outlining UI structure, reusable template components, CSS variable conventions, and per-page data/actions for the CalMiner application. - Removed outdated idempotency audit and logging audit documents as they are no longer relevant. - Updated quickstart guide to streamline developer setup instructions and link to relevant documentation. - Created a roadmap document detailing scenario enhancements and data management strategies. - Deleted the seed data plan document to consolidate information into the setup process. - Refactored setup_database.py for improved logging and error handling during database setup and migration processes.
3.0 KiB
3.0 KiB
Developer Quickstart
This document provides a quickstart guide for developers to set up and run the CalMiner application locally.
Development
See Development Setup.
User Interface
There is a dedicated UI and Style guide for frontend contributors.
Testing
Testing is described in the Testing CI document.
Staging
Staging environment setup is covered in Staging Environment Setup.
Deployment
The application can be deployed using Docker containers.
Using Docker Compose
For production deployment, use the provided docker-compose.yml:
docker-compose up -d
This starts the FastAPI app and PostgreSQL database.
Manual Docker Deployment
Build and run the container manually:
docker build -t calminer .
docker run -d -p 8000:8000 \
-e DATABASE_HOST=your-postgres-host \
-e DATABASE_USER=calminer \
-e DATABASE_PASSWORD=your-password \
-e DATABASE_NAME=calminer_db \
calminer
Ensure the database is set up and migrated before running.
Database Deployment & Migrations
See the Database Deployment & Migrations document for details on database deployment and migration strategies.
Usage Overview
- Run the application: Follow the Development Setup to get the application running locally.
- Access the UI: Open your web browser and navigate to
http://localhost:8000/uito access the user interface. - API base URL:
http://localhost:8000/api- Key routes include creating scenarios, parameters, costs, consumption, production, equipment, maintenance, and reporting summaries. See the
routes/directory for full details.
- Key routes include creating scenarios, parameters, costs, consumption, production, equipment, maintenance, and reporting summaries. See the
- UI base URL:
http://localhost:8000/ui
Theme configuration
Theming is laid out in Theming.
Where to look next
- Architecture overview & chapters: architecture (per-chapter files under
docs/architecture/) - Testing & CI
- Development setup
- Implementation plan & roadmap: Solution strategy
- Routes: routes
- Services: services
- Scripts: scripts (migrations and backfills)