@@ -11,7 +11,9 @@ cd myapp
1111```
1212
1313<details >
14- <summary >Click here to see how to change this clone to point "origin" to your own hosted repository (Recommended)</summary >
14+ <summary >
15+ Recommended: Change the clone to point to your own hosted repository.
16+ </summary >
1517
1618Rename "origin" to "upstream":
1719
@@ -33,11 +35,6 @@ git remote add origin https://github.com/yourname/myapp
3335
3436Now you can pull/push to your own repo as normal:
3537
36- ``` sh
37- git pull
38- git push origin head
39- ```
40-
4138<h3 >Why not just fork SuperStack?</h3 >
4239
4340Because you can't make a fork private.
@@ -56,8 +53,8 @@ Copy the example file:
5653cp example.env .env
5754```
5855
59- > ⚠️ The .env file is for local development only. For remote deployments,
60- > set environment variables using CI/CD or inline in the ` docker compose up ` command (be sure to avoid saving secrets in shell history) .
56+ > ⚠️ The ` .env ` file is for local development only, don't write secrets to a
57+ > file on other environments .
6158
6259## 3. Start the Stack
6360
@@ -67,19 +64,20 @@ docker compose up -d
6764
6865That's it – your backend is live.
6966
70- You can now open [ localhost:8000/openapi/] ( http://localhost:8000/openapi/ )
71- to explore your API.
67+ You can now open
68+ [ http://localhost:8000/openapi/ ] ( http://localhost:8000/openapi/ ) to explore
69+ your API.
7270
7371---
7472
7573## 🧩 What Just Happened?
7674
7775SuperStack automatically:
7876
79- - Starts a fresh ** Postgres** database
80- - Applies initial ** migrations**
81- - Launches ** PostgREST** and ** Swagger UI**
82- - Serves everything through ** Caddy**
77+ 1 . Starts a fresh Postgres database
78+ 2 . Applies initial migrations
79+ 3 . Launches PostgREST and Swagger UI
80+ 4 . Serves everything through Caddy
8381
8482``` mermaid
8583flowchart TD
@@ -90,12 +88,31 @@ flowchart TD
9088
9189> 💡 Only Caddy exposes a port – all services are routed through it.
9290
93- ## Nuke everything
91+ ## 🔄 Resetting
9492
95- To wipe your stack and start clean :
93+ If you want to start fresh :
9694
9795``` sh
9896docker compose down --volumes
97+ docker compose up -d
98+ ```
99+
100+ This will wipe your database and re-run all migrations from scratch.
101+
102+ ## Project Structure
103+
104+ ```
105+ 📁 bin/ → Helper scripts (e.g. wrappers for CLI tools)
106+ 📁 caddy/ → Custom Caddy configuration and certificates
107+ 📁 docs/ → Markdown files for SuperStack documentation
108+ 📁 postgres/ → SQL migrations and configuration of the postgres container
109+ 📄 compose.yaml → Main Docker Compose config
110+ 📄 compose.override.yaml → Optional local overrides (development only)
111+ 📄 example.env → Example environment variables — copy to `.env`
112+ 📄 LICENSE → License file (MIT)
113+ 📄 logo.png → SuperStack logo for README/docs
114+ 📄 mkdocs.yml → MkDocs configuration for documentation site
115+ 📄 README.md → Overview and quick start for the repository
99116```
100117
101118## ➕ What's Next?
0 commit comments