33SuperStack uses Docker, so make sure [ Docker is
44installed] ( https://docs.docker.com/get-docker/ ) before you begin.
55
6- ## Get SuperStack
6+ ## 1. Get SuperStack
77
88### Option 1: Use the Template (Recommended)
99
@@ -12,7 +12,7 @@ The easiest way to get started:
1212Click [ Use this template] ( https://github.com/explodinglabs/superstack/generate )
1313and create a new repository (e.g. ` myapp ` ) on GitHub.
1414
15- Clone your new repository :
15+ Clone it to your machine :
1616
1717``` sh
1818git clone https://github.com/yourname/myapp.git
@@ -21,15 +21,15 @@ cd myapp
2121
2222### Option 2: Clone and Track Upstream (Advanced)
2323
24- If you want to keep SuperStack’s Git history and pull upstream SuperStack
25- changes later, clone SuperStack:
24+ If you want to keep SuperStack’s Git history and pull upstream changes later,
25+ clone SuperStack:
2626
2727``` sh
2828git clone https://github.com/explodinglabs/superstack.git myapp
2929cd myapp
3030```
3131
32- Create your own repo at [ https://github.com/new ] ( https://github.com/new ) , then:
32+ [ Create your own repo] ( https://github.com/new ) , then:
3333
3434``` sh
3535git remote rename origin upstream
@@ -51,8 +51,8 @@ Copy the example file:
5151cp example.env .env
5252```
5353
54- > ⚠️ The .env file is for local development only. For remote deployments,
55- > set environment variables using CI/CD or inline in the ` docker compose up ` command (be sure to avoid saving secrets in shell history) .
54+ > ⚠️ ** The .env file is for local development only.** Don't store real secrets
55+ > in production — use CI/CD environment variables or a secrets manager .
5656
5757## 3. Start the Stack
5858
@@ -63,7 +63,7 @@ docker compose up -d
6363That's it – your backend is live.
6464
6565You can now open
66- [ https ://localhost:8000/openapi/] ( http://localhost:8000/openapi/ ) to explore
66+ [ http ://localhost:8000/openapi/] ( http://localhost:8000/openapi/ ) to explore
6767your API.
6868
6969---
@@ -72,10 +72,10 @@ your API.
7272
7373SuperStack automatically:
7474
75- - Starts a fresh ** Postgres** database
76- - Applies initial ** migrations**
77- - Launches ** PostgREST** and ** Swagger UI**
78- - Serves everything through ** Caddy**
75+ 1 . Starts a fresh Postgres database
76+ 2 . Applies initial migrations
77+ 3 . Launches PostgREST and Swagger UI
78+ 4 . Serves everything through Caddy
7979
8080``` mermaid
8181flowchart TD
@@ -86,14 +86,33 @@ flowchart TD
8686
8787> 💡 Only Caddy exposes a port – all services are routed through it.
8888
89- ## Nuke everything
89+ ## Project Structure
9090
91- To wipe your stack and start clean:
91+ ```
92+ 📁 bin/ → Helper scripts (e.g. wrappers for CLI tools)
93+ 📁 caddy/ → Custom Caddy configuration and certificates
94+ 📁 docs/ → Markdown files for SuperStack documentation
95+ 📁 postgres/ → SQL migrations and configuration of the postgres container
96+ 📄 compose.yaml → Main Docker Compose config
97+ 📄 compose.override.yaml → Optional local overrides (development only)
98+ 📄 example.env → Example environment variables — copy to `.env`
99+ 📄 LICENSE → License file (MIT)
100+ 📄 logo.png → SuperStack logo for README/docs
101+ 📄 mkdocs.yml → MkDocs configuration for documentation site
102+ 📄 README.md → Overview and quick start for the repository
103+ ```
104+
105+ ## 🔄 Resetting
106+
107+ If you want to start fresh:
92108
93109``` sh
94110docker compose down --volumes
111+ docker compose up -d
95112```
96113
114+ This will wipe your database and re-run all migrations from scratch.
115+
97116## ➕ What's Next?
98117
99118👉 [ Create your database schema with migrations] ( migrations.md )
0 commit comments