BoilerWorks
| 6f83112… | anonymous | 1 | # Quick Start |
| 6f83112… | anonymous | 2 | |
| 6f83112… | anonymous | 3 | Get a working project in under 5 minutes. |
| 6f83112… | anonymous | 4 | |
| 6f83112… | anonymous | 5 | ## 1. Install |
| 6f83112… | anonymous | 6 | |
| 6f83112… | anonymous | 7 | ```bash |
| 6f83112… | anonymous | 8 | pip install boilerworks |
| 6f83112… | anonymous | 9 | ``` |
| 6f83112… | anonymous | 10 | |
| 6f83112… | anonymous | 11 | ## 2. Pick a template |
| 6f83112… | anonymous | 12 | |
| 6f83112… | anonymous | 13 | ```bash |
| 6f83112… | anonymous | 14 | boilerworks list |
| 6f83112… | anonymous | 15 | ``` |
| 6f83112… | anonymous | 16 | |
| 6f83112… | anonymous | 17 | This shows all 26 templates with size, language, and description. |
| 6f83112… | anonymous | 18 | |
| 6f83112… | anonymous | 19 | ```bash |
| 6f83112… | anonymous | 20 | boilerworks list --size full # only Full templates |
| 6f83112… | anonymous | 21 | boilerworks list --language python # only Python templates |
| 6f83112… | anonymous | 22 | ``` |
| 6f83112… | anonymous | 23 | |
| 6f83112… | anonymous | 24 | ## 3. Run the wizard |
| 6f83112… | anonymous | 25 | |
| 6f83112… | anonymous | 26 | ```bash |
| 6f83112… | anonymous | 27 | boilerworks setup |
| 6f83112… | anonymous | 28 | ``` |
| 6f83112… | anonymous | 29 | |
| 6f83112… | anonymous | 30 | The wizard asks 13 questions: |
| 6f83112… | anonymous | 31 | |
| 6f83112… | anonymous | 32 | 1. **Project name** — slug format (e.g. `my-app`) |
| 6f83112… | anonymous | 33 | 2. **Template size** — Full / Micro / Edge |
| 6f83112… | anonymous | 34 | 3. **Template family** — filtered list based on size |
| 6f83112… | anonymous | 35 | 4. **Topology** — standard (separate repos) or omni (monorepo) |
| 6f83112… | anonymous | 36 | 5. **Cloud provider** — aws / gcp / azure / none |
| 6f83112… | anonymous | 37 | 6. **Infrastructure** — include boilerworks-opscode? (yes/no, if cloud selected) |
| 6f83112… | anonymous | 38 | 7. **Region** — e.g. `us-east-1` |
| 6f83112… | anonymous | 39 | 8. **Domain** — e.g. `myapp.com` |
| 6f83112… | anonymous | 40 | 9. **Mobile** — include mobile template? (Full only) |
| 6f83112… | anonymous | 41 | 10. **Web presence** — include marketing site? (Full only) |
| 6f83112… | anonymous | 42 | 11. **Compliance** — SOC2 / HIPAA / PCI-DSS / GDPR |
| 6f83112… | anonymous | 43 | 12. **Email provider** — SES / SendGrid / Mailgun |
| 6f83112… | anonymous | 44 | 13. **E2E testing** — Playwright / Cypress |
| 6f83112… | anonymous | 45 | |
| 6f83112… | anonymous | 46 | Writes `boilerworks.yaml` to the current directory. |
| 6f83112… | anonymous | 47 | |
| 6f83112… | anonymous | 48 | ## 4. Generate |
| 6f83112… | anonymous | 49 | |
| 6f83112… | anonymous | 50 | ```bash |
| 6f83112… | anonymous | 51 | boilerworks init |
| 6f83112… | anonymous | 52 | ``` |
| 6f83112… | anonymous | 53 | |
| 6f83112… | anonymous | 54 | This: |
| 6f83112… | anonymous | 55 | |
| 6f83112… | anonymous | 56 | 1. Clones the template from `ConflictHQ/boilerworks-{family}` |
| 6f83112… | anonymous | 57 | 2. Removes `.git/` |
| 6f83112… | anonymous | 58 | 3. Replaces all `boilerworks` strings with your project name (case-variant) |
| 6f83112… | anonymous | 59 | 4. Renames any files/directories containing `boilerworks` |
| 6f83112… | anonymous | 60 | 5. If cloud + ops selected: clones `boilerworks-opscode` and configures it |
| 6f83112… | anonymous | 61 | 6. Runs `git init` + initial commit |
| 6f83112… | anonymous | 62 | |
| 6f83112… | anonymous | 63 | ## 5. Boot it |
| 6f83112… | anonymous | 64 | |
| 6f83112… | anonymous | 65 | ```bash |
| 6f83112… | anonymous | 66 | cd my-app |
| 6f83112… | anonymous | 67 | docker compose up -d |
| 6f83112… | anonymous | 68 | ``` |
| 6f83112… | anonymous | 69 | |
| 6f83112… | anonymous | 70 | Visit `http://localhost:3000`. Your app is running with your project name everywhere. |
| 6f83112… | anonymous | 71 | |
| 6f83112… | anonymous | 72 | ## What you get |
| 6f83112… | anonymous | 73 | |
| 6f83112… | anonymous | 74 | Every Full template ships with: |
| 6f83112… | anonymous | 75 | |
| 6f83112… | anonymous | 76 | - User auth (login, logout, session management) |
| 6f83112… | anonymous | 77 | - Group-based permissions |
| 6f83112… | anonymous | 78 | - Items + Categories CRUD |
| 6f83112… | anonymous | 79 | - Form definitions + submissions |
| 6f83112… | anonymous | 80 | - Workflow definitions + instances |
| 6f83112… | anonymous | 81 | - Admin dashboard |
| 6f83112… | anonymous | 82 | - Background jobs |
| 6f83112… | anonymous | 83 | - PostgreSQL 16 + Redis 7 |
| 6f83112… | anonymous | 84 | - Docker Compose (dev) + Dockerfile (prod) |
| 6f83112… | anonymous | 85 | - Health check endpoint |
| 6f83112… | anonymous | 86 | - RSpec / pytest tests |
| 6f83112… | anonymous | 87 | - CI pipeline |
| 6f83112… | anonymous | 88 | |
| 6f83112… | anonymous | 89 | !!! tip "Dry run first" |
| 6f83112… | anonymous | 90 | Not sure what will happen? Run `boilerworks init --dry-run` to see the full plan without touching the filesystem. |