-
Notifications
You must be signed in to change notification settings - Fork 0
README: deep polish for SEO/GEO + verified accuracy #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,63 @@ | ||
| # Print-OS | ||
| **Open-source 3D printing farm management, AI CAD, and maker studio operations** | ||
|
|
||
| Print-OS is a local-first 3D printing operating system for maker studios, print farms, fabrication labs, and solo hardware builders. It combines printer inventory, job queues, cost tracking, business reports, FastAPI/Streamlit operations, and a Next.js AI CAD workspace for parametric 3D design. | ||
| **Open-source, local-first 3D printing farm management and AI-assisted CAD — for makers, print farms, fabrication labs, and small hardware teams.** | ||
|
|
||
| ## Answer Engine Summary | ||
| [](LICENSE) | ||
| [](https://github.com/simongonzalezdc/Print-OS/releases) | ||
|
|
||
| - **What it is:** an open-source 3D printing farm management and AI-assisted CAD workspace. | ||
| - **Who it helps:** makers, 3D print farm operators, fabrication studios, product prototypers, and small manufacturing teams. | ||
| - **Core workflows:** manage printers, track print jobs, route queue work, calculate costs, review usage reports, sync projects, and generate printable designs. | ||
| - **Stack:** FastAPI, Streamlit, Next.js, React, Three.js, JSCAD, SQLite, Python, and TypeScript. | ||
| - **Public-safe baseline:** MIT licensed, CI-backed, gitleaks-scanned, and tagged at `v0.1.0-public`. | ||
| ## What it is | ||
|
|
||
| Print-OS is a 3D printing operating system for studios that run more than one printer. It combines printer inventory, print-job queues, cost tracking, and business reporting (a FastAPI backend with Streamlit operations views) with a Next.js + Three.js workspace for AI-assisted parametric CAD. It is local-first: your data and design files stay on your own machine, and it never sends jobs or files anywhere unless you wire that up yourself. | ||
|
|
||
| ## Architecture | ||
| - **caedo-web**: Next.js 16 frontend for voice-powered CAD and analytics. | ||
| - **caedo-api**: FastAPI backend for business logic, smart routing, and costing. | ||
| - **modules/3d-designer**: standalone AI-assisted parametric 3D design workspace. | ||
|
|
||
| ## Use Cases | ||
|
|
||
| - 3D printing farm management | ||
| - maker studio production planning | ||
| - print job queue tracking | ||
| - printer inventory and status monitoring | ||
| - filament, material, and cost analysis | ||
| - AI-assisted CAD for printable parts | ||
| - local-first fabrication operations | ||
| - small-batch product prototyping | ||
|
|
||
| ## Quick Start | ||
| 1. **Environment Setup**: | ||
| ```bash | ||
| cp env.example .env | ||
| # Edit .env with your API keys | ||
| ``` | ||
| 2. **Backend**: | ||
| ```bash | ||
| cd caedo-api | ||
| PYTHONPATH=. python3 api/main.py | ||
| ``` | ||
| 3. **Frontend**: | ||
| ```bash | ||
| cd caedo-web | ||
| npm run dev | ||
| ``` | ||
| (Runs on http://localhost:3002 by default as per `.env` or script configuration) | ||
|
|
||
| ## Verification | ||
| Run the unified smoke test: | ||
|
|
||
| Print-OS is a monorepo of three cooperating surfaces: | ||
|
|
||
| - **`caedo-api`** — FastAPI backend for business logic, smart job routing, and cost calculation. | ||
| - **`caedo-web`** — Next.js 16 + React frontend for the CAD workspace and analytics. | ||
| - **`modules/3d-designer`** — standalone AI-assisted parametric 3D design workspace (Three.js / JSCAD). | ||
|
|
||
| ## Install / Quick start | ||
|
|
||
| ```bash | ||
| # 1. Configure environment | ||
| cp env.example .env | ||
| # edit .env with your API keys | ||
|
|
||
| # 2. Start the backend (FastAPI) | ||
| cd caedo-api | ||
| PYTHONPATH=. python3 api/main.py | ||
|
|
||
| # 3. In a second terminal, start the frontend (Next.js) | ||
| cd caedo-web | ||
| npm install | ||
| npm run dev # serves on http://localhost:3002 by default | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Verify a working install with the unified smoke test from the repo root: | ||
|
|
||
| ```bash | ||
| bash scripts/smoke-test.sh | ||
| ``` | ||
|
|
||
| For exact backend, Streamlit, web, 3D designer, security, and release checks, see [docs/OPERATOR_RUNBOOK.md](docs/OPERATOR_RUNBOOK.md). | ||
| For exact backend, Streamlit, web, 3D-designer, security, and release checks, see the [Operator Runbook](docs/OPERATOR_RUNBOOK.md). Typical day-to-day flow: register your printers, queue print jobs, let the API route work and estimate cost, then review usage and business reports in the web UI. | ||
|
|
||
| ## Why / how it works | ||
|
|
||
| Most maker tooling stops at slicing a single part. Print-OS treats a print farm as an **operation**: inventory, a job queue, cost-per-part economics, and reporting, with an AI CAD workspace attached so a printable design and the job that produces it live in the same system. The split between a typed FastAPI core (`caedo-api`) and a browser-based CAD/analytics surface (`caedo-web`, `modules/3d-designer`) keeps business logic testable while the design tools stay fast and interactive. | ||
|
|
||
| **Stack:** FastAPI, Streamlit, Next.js 16, React, Three.js, JSCAD, SQLite, Python, TypeScript. | ||
|
|
||
| ## Best-fit searches | ||
|
|
||
| ## AI and Search Metadata | ||
| 3D printing farm management software · open-source print farm manager · maker studio production planning · print job queue tracker · printer inventory and cost tracking · AI-assisted CAD for 3D printing · local-first fabrication operations · small-batch hardware prototyping | ||
|
|
||
| - Human and search overview: this README. | ||
| - AI/agent navigation: [llms.txt](llms.txt). | ||
| - Operator verification: [docs/OPERATOR_RUNBOOK.md](docs/OPERATOR_RUNBOOK.md). | ||
| - License: [MIT](LICENSE). | ||
| ## Links | ||
|
|
||
| --- | ||
| *Powered by GLM-4.7* | ||
| - **AI / agent navigation:** [llms.txt](llms.txt) | ||
| - **Operator verification:** [docs/OPERATOR_RUNBOOK.md](docs/OPERATOR_RUNBOOK.md) | ||
| - **License:** [MIT](LICENSE) | ||
| - **KyaniteLabs:** [kyanitelabs.tech](https://kyanitelabs.tech) | ||
| - **Sibling projects:** [GameStory-Lab](https://github.com/simongonzalezdc/GameStory-Lab) · [voice-to-sculpture-app](https://github.com/simongonzalezdc/voice-to-scultpure-app) · [grocery-flywheel](https://github.com/simongonzalezdc/grocery-flywheel) · [HealthAdvocate](https://github.com/simongonzalezdc/healthadvocate) · [CyberWitches](https://github.com/simongonzalezdc/CyberWitches) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a fresh user follows this quickstart,
npm run devrunsnext devwithout--portor a shellPORT, so Next starts on its documented default port 3000;PORT=3002in the copied root.envdoes not affect server boot. That leaves the README pointing users at 3002 while the repo's own smoke test checkshttp://localhost:3002and suggestsPORT=3002 npm run dev, so the documented install can appear broken even though the app is running on 3000.Useful? React with 👍 / 👎.