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