Skip to content

Commit 369756e

Browse files
agjscursoragent
andcommitted
docs: monorepo README with BoringStack branding
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 88cb728 commit 369756e

2 files changed

Lines changed: 60 additions & 49 deletions

File tree

README.md

Lines changed: 57 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,37 @@
1-
# BoringStack
1+
<p align="center">
2+
<a href="https://boringstack.xyz">
3+
<img src="apps/docs/profile/assets/boringstack-xyz.png" alt="BoringStack" />
4+
</a>
5+
</p>
26

3-
Production-ready full-stack starter: Bun + Elysia API, Vite + React UI, Astro docs, Docker Compose infra, and optional OpenTofu bootstrap — in one monorepo.
7+
<p align="center">
8+
<a href="https://boringstack.xyz"><img src="https://img.shields.io/badge/boringstack.xyz-4ade80?style=for-the-badge&logo=safari&logoColor=4ade80&labelColor=090909" alt="boringstack.xyz"></a>
9+
<a href="https://github.com/boringstack-xyz/boringstack"><img src="https://img.shields.io/badge/GitHub-4ade80?style=for-the-badge&logo=github&logoColor=4ade80&labelColor=090909" alt="GitHub"></a>
10+
<a href="https://boringstack.xyz/quickstart/"><img src="https://img.shields.io/badge/Quickstart-4ade80?style=for-the-badge&logo=readthedocs&logoColor=4ade80&labelColor=090909" alt="Quickstart"></a>
11+
</p>
412

5-
## Layout
13+
<p align="center">
14+
<img src="https://img.shields.io/badge/License-MIT-e8e8ed?style=for-the-badge&labelColor=090909" alt="MIT">
15+
<img src="https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=fbf0df&labelColor=090909" alt="Bun">
16+
<img src="https://img.shields.io/badge/React-20232a?style=for-the-badge&logo=react&logoColor=61dafb&labelColor=090909" alt="React">
17+
<img src="https://img.shields.io/badge/Elysia-4ade80?style=for-the-badge&labelColor=090909" alt="Elysia">
18+
<img src="https://img.shields.io/badge/TypeScript-3178c6?style=for-the-badge&logo=typescript&logoColor=3178c6&labelColor=090909" alt="TypeScript">
19+
<img src="https://img.shields.io/badge/Docker-2496ed?style=for-the-badge&logo=docker&logoColor=2496ed&labelColor=090909" alt="Docker">
20+
<img src="https://img.shields.io/badge/PostgreSQL-4169e1?style=for-the-badge&logo=postgresql&logoColor=4169e1&labelColor=090909" alt="PostgreSQL">
21+
</p>
622

7-
```
8-
apps/
9-
api/ Bun + Elysia + Drizzle API
10-
ui/ Vite + React SPA
11-
docs/ boringstack.xyz (Astro Starlight)
12-
infra/
13-
compose/ Docker Compose runtime
14-
bootstrap/ OpenTofu VPS bootstrap (optional)
15-
```
23+
<p align="center">
24+
<strong>Production-ready from the first fork.</strong><br />
25+
One monorepo for the full stack. Clone, boot with <code>./setup.sh --up</code>, deploy on Compose.
26+
</p>
27+
28+
<p align="center">
29+
<a href="https://github.com/boringstack-xyz/boringstack/tree/main/apps/api"><img src="https://img.shields.io/badge/apps--api-4ade80?style=for-the-badge&labelColor=090909" alt="apps/api"></a>
30+
<a href="https://github.com/boringstack-xyz/boringstack/tree/main/apps/ui"><img src="https://img.shields.io/badge/apps--ui-4ade80?style=for-the-badge&labelColor=090909" alt="apps/ui"></a>
31+
<a href="https://github.com/boringstack-xyz/boringstack/tree/main/infra/compose"><img src="https://img.shields.io/badge/infra--compose-4ade80?style=for-the-badge&labelColor=090909" alt="infra/compose"></a>
32+
<a href="https://github.com/boringstack-xyz/boringstack/tree/main/infra/bootstrap"><img src="https://img.shields.io/badge/infra--bootstrap-4ade80?style=for-the-badge&labelColor=090909" alt="infra/bootstrap"></a>
33+
<a href="https://github.com/boringstack-xyz/eslint-plugins"><img src="https://img.shields.io/badge/eslint--plugins-4ade80?style=for-the-badge&labelColor=090909" alt="eslint-plugins"></a>
34+
</p>
1635

1736
## Quick start
1837

@@ -25,12 +44,37 @@ open http://localhost:3001
2544

2645
Sign in with `SUPERUSER_EMAIL` / `SUPERUSER_PASSWORD` from `infra/compose/compose/.env`, or register a new account.
2746

47+
Docs: [boringstack.xyz/quickstart](https://boringstack.xyz/quickstart/)
48+
49+
## Layout
50+
51+
```
52+
apps/
53+
api/ Bun + Elysia + Drizzle API
54+
ui/ Vite + React SPA
55+
docs/ boringstack.xyz (Astro Starlight)
56+
infra/
57+
compose/ Docker Compose runtime
58+
bootstrap/ OpenTofu VPS bootstrap (optional)
59+
```
60+
61+
| Path | Was | Role |
62+
|------|-----|------|
63+
| `apps/api` | api-template | Bun + Elysia API |
64+
| `apps/ui` | ui-template | Vite + React UI |
65+
| `apps/docs` | .github / boringstack.xyz | Astro docs site |
66+
| `infra/compose` | infra-docker-compose-template | Docker Compose |
67+
| `infra/bootstrap` | infra-bootstrap-tofu-template | OpenTofu bootstrap |
68+
2869
## Maintainer commands (repo root)
2970

3071
```bash
3172
bun run regen # ACL → OpenAPI → lint-meta RULES → docs JSON catalogs
3273
bun run check # all cross-app drift checks (needs api on :3000 for OpenAPI)
3374
bun run check:full # check + api/ui validate + docs build:ci
75+
./scripts/audit-repo-settings.sh # diff GitHub repo settings vs desired config
3476
```
3577

36-
Docs site: [boringstack.xyz](https://boringstack.xyz) — built from `apps/docs`.
78+
## License
79+
80+
MIT

apps/docs/profile/README.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,5 @@
1-
<p align="center">
2-
<a href="https://boringstack.xyz">
3-
<img src="./assets/boringstack-xyz.png" alt="BoringStack" />
4-
</a>
5-
</p>
1+
# Org profile README (archived)
62

7-
<p align="center">
8-
<a href="https://boringstack.xyz"><img src="https://img.shields.io/badge/boringstack.xyz-4ade80?style=for-the-badge&logo=safari&logoColor=4ade80&labelColor=090909" alt="boringstack.xyz"></a>
9-
<a href="https://github.com/boringstack-xyz"><img src="https://img.shields.io/badge/GitHub-4ade80?style=for-the-badge&logo=github&logoColor=4ade80&labelColor=090909" alt="GitHub"></a>
10-
<a href="https://boringstack.xyz/quickstart/"><img src="https://img.shields.io/badge/Quickstart-4ade80?style=for-the-badge&logo=readthedocs&logoColor=4ade80&labelColor=090909" alt="Quickstart"></a>
11-
</p>
3+
The canonical README is at the [monorepo root](https://github.com/boringstack-xyz/boringstack#readme).
124

13-
<p align="center">
14-
<img src="https://img.shields.io/badge/License-MIT-e8e8ed?style=for-the-badge&labelColor=090909" alt="MIT">
15-
<img src="https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=fbf0df&labelColor=090909" alt="Bun">
16-
<img src="https://img.shields.io/badge/React-20232a?style=for-the-badge&logo=react&logoColor=61dafb&labelColor=090909" alt="React">
17-
<img src="https://img.shields.io/badge/Elysia-4ade80?style=for-the-badge&labelColor=090909" alt="Elysia">
18-
<img src="https://img.shields.io/badge/TypeScript-3178c6?style=for-the-badge&logo=typescript&logoColor=3178c6&labelColor=090909" alt="TypeScript">
19-
<img src="https://img.shields.io/badge/Docker-2496ed?style=for-the-badge&logo=docker&logoColor=2496ed&labelColor=090909" alt="Docker">
20-
<img src="https://img.shields.io/badge/PostgreSQL-4169e1?style=for-the-badge&logo=postgresql&logoColor=4169e1&labelColor=090909" alt="PostgreSQL">
21-
</p>
22-
23-
<p align="center">
24-
<strong>Production-ready from the first fork.</strong><br />
25-
GitHub templates for the full stack. Fork the org, boot with <code>compose/dev.sh</code>, deploy on Compose.
26-
</p>
27-
28-
<p align="center">
29-
<a href="https://github.com/boringstack-xyz/api-template"><img src="https://img.shields.io/badge/api--template-4ade80?style=for-the-badge&labelColor=090909" alt="api-template"></a>
30-
<a href="https://github.com/boringstack-xyz/ui-template"><img src="https://img.shields.io/badge/ui--template-4ade80?style=for-the-badge&labelColor=090909" alt="ui-template"></a>
31-
<a href="https://github.com/boringstack-xyz/infra-docker-compose-template"><img src="https://img.shields.io/badge/infra--compose-4ade80?style=for-the-badge&labelColor=090909" alt="infra-docker-compose-template"></a>
32-
<a href="https://github.com/boringstack-xyz/infra-bootstrap-tofu-template"><img src="https://img.shields.io/badge/infra--tofu-4ade80?style=for-the-badge&labelColor=090909" alt="infra-bootstrap-tofu-template"></a>
33-
<a href="https://github.com/boringstack-xyz/eslint-plugins"><img src="https://img.shields.io/badge/eslint--plugins-4ade80?style=for-the-badge&labelColor=090909" alt="eslint-plugins"></a>
34-
</p>
35-
36-
## License
37-
38-
MIT on each template.
5+
When updating the GitHub org profile (`boringstack-xyz/.github/profile/README.md`), copy from [`../../README.md`](../../README.md). Banner asset: [`assets/boringstack-xyz.png`](./assets/boringstack-xyz.png).

0 commit comments

Comments
 (0)