BoilerWorks

boilerworks / README.md

Source Rendered

Blame History Raw 205 lines

1	`# Boilerworks`
2
3	`Production-ready project templates — assembled in seconds.`
4
5	Boilerworks is a CLI that clones and configures any of 26 opinionated, best-of-breed project templates. Stop re-solving auth, permissions, Docker, CI, and admin panels from scratch. Pick a stack, run `boilerworks init`, and get straight to your business logic.
6
7	```bash
8	`pip install boilerworks`
9	`boilerworks setup # interactive wizard → writes boilerworks.yaml`
10	`boilerworks init # clone + configure the template`
11	`cd my-project`
12	`docker compose up -d # full stack running in seconds`
13	```
14
15	`---`
16
17	`## Installation`
18
19	```bash
20	`pip install boilerworks`
21	`# or with uv:`
22	`uv tool install boilerworks`
23	```
24
25	`Requires Python 3.12+.`
26
27	`---`
28
29	`## Quick Start`
30
31	`### 1. Run the setup wizard`
32
33	```bash
34	`boilerworks setup`
35	```
36
37	Answer 13 questions about your project (name, template, cloud, compliance, etc.) and a `boilerworks.yaml` manifest is written to the current directory.
38
39	`### 2. Generate the project`
40
41	```bash
42	`boilerworks init`
43	```
44
45	Boilerworks clones the selected template, replaces all `boilerworks` references with your project name, and runs `git init` to give you a clean starting commit.
46
47	`### 3. Start developing`
48
49	```bash
50	`cd my-project`
51	`docker compose up -d`
52	`# Visit http://localhost:3000`
53	```
54
55	`One command. Full stack. No manual setup.`
56
57	`---`
58
59	`## Template Catalogue`
60
61	`26 templates across three sizes:`
62
63	`\| Size \| Description \| Auth \| Deploy Target \|`
64	`\|------\|-------------\|------\|---------------\|`
65	`\| Full \| Apps with users \| Session auth, permissions, org management \| VPS, containers, Kubernetes \|`
66	`\| Micro \| API services \| API-key auth \| VPS, containers \|`
67	`\| Edge \| Serverless apps \| Flexible \| Cloudflare Workers / Pages \|`
68
69	`### Full Templates (15)`
70
71	`\| Name \| Backend \| Frontend \|`
72	`\|------\|---------\|----------\|`
73	`\| [django-nextjs](https://github.com/ConflictHQ/boilerworks-django-nextjs) \| Django 5 \| Next.js 16 \|`
74	`\| [nestjs-nextjs](https://github.com/ConflictHQ/boilerworks-nestjs-nextjs) \| NestJS 11 \| Next.js 16 \|`
75	`\| [rails-hotwire](https://github.com/ConflictHQ/boilerworks-rails-hotwire) \| Rails 8 \| Hotwire + Tailwind \|`
76	`\| [rails-nextjs](https://github.com/ConflictHQ/boilerworks-rails-nextjs) \| Rails 8 \| Next.js 16 \|`
77	`\| [spring-angular](https://github.com/ConflictHQ/boilerworks-spring-angular) \| Spring Boot 3 \| Angular 19 \|`
78	`\| [go-nextjs](https://github.com/ConflictHQ/boilerworks-go-nextjs) \| Go + Chi \| Next.js 16 \|`
79	`\| [phoenix-liveview](https://github.com/ConflictHQ/boilerworks-phoenix-liveview) \| Phoenix 1.7 \| LiveView \|`
80	`\| [laravel-vue](https://github.com/ConflictHQ/boilerworks-laravel-vue) \| Laravel 12 \| Inertia + Vue 3 \|`
81	`\| [django-htmx](https://github.com/ConflictHQ/boilerworks-django-htmx) \| Django 5 \| HTMX + Alpine.js \|`
82	`\| [fastapi-nextjs](https://github.com/ConflictHQ/boilerworks-fastapi-nextjs) \| FastAPI \| Next.js 16 \|`
83	`\| [spring-nextjs](https://github.com/ConflictHQ/boilerworks-spring-nextjs) \| Spring Boot 3 \| Next.js 16 \|`
84	`\| [laravel-livewire](https://github.com/ConflictHQ/boilerworks-laravel-livewire) \| Laravel 12 \| Livewire 3 \|`
85	`\| [go-htmx](https://github.com/ConflictHQ/boilerworks-go-htmx) \| Go + Chi \| HTMX + Templ \|`
86	`\| [fastapi-htmx](https://github.com/ConflictHQ/boilerworks-fastapi-htmx) \| FastAPI \| HTMX + Alpine.js \|`
87	`\| [saleor-nextjs](https://github.com/ConflictHQ/boilerworks-saleor-nextjs) \| Saleor (Django) \| Next.js 16 \|`
88
89	`### Micro Templates (6)`
90
91	`\| Name \| Backend \|`
92	`\|------\|---------\|`
93	`\| [django-micro](https://github.com/ConflictHQ/boilerworks-django-micro) \| Django 5 (DRF/Ninja) \|`
94	`\| [fastapi-micro](https://github.com/ConflictHQ/boilerworks-fastapi-micro) \| FastAPI \|`
95	`\| [nestjs-micro](https://github.com/ConflictHQ/boilerworks-nestjs-micro) \| NestJS 11 \|`
96	`\| [go-micro](https://github.com/ConflictHQ/boilerworks-go-micro) \| Go + Chi \|`
97	`\| [rust-micro](https://github.com/ConflictHQ/boilerworks-rust-micro) \| Axum (Rust) \|`
98	`\| [cherrypy-micro](https://github.com/ConflictHQ/boilerworks-cherrypy-micro) \| CherryPy \|`
99
100	`### Edge Templates (5)`
101
102	`\| Name \| Framework \|`
103	`\|------\|-----------\|`
104	`\| [sveltekit-full](https://github.com/ConflictHQ/boilerworks-sveltekit-full) \| SvelteKit \|`
105	`\| [remix-full](https://github.com/ConflictHQ/boilerworks-remix-full) \| Remix \|`
106	`\| [hono-micro](https://github.com/ConflictHQ/boilerworks-hono-micro) \| Hono (Cloudflare Workers) \|`
107	`\| [nuxt-full](https://github.com/ConflictHQ/boilerworks-nuxt-full) \| Nuxt 4 \|`
108	`\| [astro-site](https://github.com/ConflictHQ/boilerworks-astro-site) \| Astro \|`
109
110	`---`
111
112	`## Commands`
113
114	```bash
115	`boilerworks --help # show all commands`
116	`boilerworks list # show all 26 templates`
117	`boilerworks list --size micro # filter by size`
118	`boilerworks list --language python # filter by language`
119	`boilerworks setup # interactive wizard`
120	`boilerworks init # generate project from boilerworks.yaml`
121	`boilerworks init --dry-run # preview what would happen`
122	`boilerworks init --manifest ./path/to/boilerworks.yaml`
123	`boilerworks init --output /path/to/output`
124	```
125
126	`---`
127
128	`## boilerworks.yaml`
129
130	The manifest file describes your project. Generated by `boilerworks setup`, editable by hand.
131
132	```yaml
133	`project: my-app`
134	`family: django-nextjs`
135	`size: full`
136	`topology: standard`
137	`cloud: aws`
138	`ops: true`
139	`region: us-east-1`
140	`domain: myapp.com`
141	`mobile: false`
142	`web_presence: false`
143	`compliance:`
144	`- soc2`
145	`services:`
146	`email: ses`
147	`cache: redis`
148	`data:`
149	`database: postgres`
150	`migrations: true`
151	`seed_data: true`
152	`testing:`
153	`e2e: playwright`
154	`unit: true`
155	`integration: true`
156	```
157
158	See [`boilerworks.yaml.example`](boilerworks.yaml.example) for a fully annotated version.
159
160	`---`
161
162	`## What Every Template Includes`
163
164	`Every Boilerworks Full template ships with:`
165
166	`- Auth — session-based (httpOnly cookies), bcrypt passwords`
167	`- Permissions — group-based, per-operation, checked at every endpoint`
168	`- Background jobs — Redis-backed queue, retries, dead-letter handling`
169	`- Email — provider-agnostic (SES, SendGrid, Mailgun, Mailpit locally)`
170	`- Admin — authenticated management interface with CRUD for all models`
171	`- Docker Compose — one command to boot the full stack`
172	`- CI/CD — GitHub Actions: lint, test, build, audit`
173	`- AI agent shims — CLAUDE.md, AGENTS.md, bootstrap.md`
174
175	`---`
176
177	`## Infrastructure`
178
179	`Pair any template with [boilerworks-opscode](https://github.com/ConflictHQ/boilerworks-opscode) for production Terraform:`
180
181	`- AWS — ECS Fargate, RDS Postgres 16, ElastiCache Redis, ALB, Route53, ACM, S3, Secrets Manager`
182	`- GCP / Azure — structured stubs ready for expansion`
183
184	Select a cloud in `boilerworks setup` and `boilerworks init` will clone and configure the ops repo alongside your app.
185
186	`---`
187
188	`## Contributing`
189
190	`See [CONTRIBUTING.md](CONTRIBUTING.md) for the development process.`
191
192	`Issues and PRs welcome at [github.com/ConflictHQ/boilerworks](https://github.com/ConflictHQ/boilerworks).`
193
194	`---`
195
196	`## Links`
197
198	`- Documentation: [boilerworks.dev](https://boilerworks.dev)`
199	`- Product: [boilerworks.ai](https://boilerworks.ai)`
200	`- Templates: [github.com/ConflictHQ](https://github.com/ConflictHQ)`
201
202	`---`
203
204	`Boilerworks is a [CONFLICT](https://weareconflict.com) brand. CONFLICT is a registered trademark of CONFLICT LLC.`
205

BoilerWorks

Keyboard Shortcuts