Add initial MySQL schema, gitignore, and improved README
- db.sql: tables for printers, filaments, print_jobs, todos, pricing_config - .gitignore: excludes .env files and Python build artefacts - README: cleaned up structure and added Getting Started section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
40
README.md
40
README.md
@@ -0,0 +1,40 @@
|
||||
# POPS — Printing Operations Production System
|
||||
|
||||
A web-based production management system for 3D print farms.
|
||||
|
||||
## Features
|
||||
|
||||
- **Printer overview** — see all printers and their current status at a glance
|
||||
- **Job queue** — track what is printing now and what is in the pipeline
|
||||
- **Status updates & to-do lists** — stay on top of ongoing work
|
||||
- **Filament database** — connect to and manage your filament inventory
|
||||
- **Price calculator** — calculate job costs
|
||||
- **Print log** — keep a history of completed print jobs
|
||||
|
||||
## Stack
|
||||
|
||||
- **Backend:** FastAPI
|
||||
- **Frontend:** Web UI (served by FastAPI)
|
||||
- **Database:** MySQL (managed via Alembic migrations)
|
||||
- **Deployment:** Docker
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Docker & Docker Compose
|
||||
- A MySQL database instance
|
||||
|
||||
### Run
|
||||
|
||||
```bash
|
||||
docker compose up
|
||||
```
|
||||
|
||||
The application will be available at [http://localhost:8720](http://localhost:8720).
|
||||
|
||||
### Database Migrations
|
||||
|
||||
```bash
|
||||
alembic upgrade head
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user