33SuperStack uses Docker, so make sure [ Docker is
44installed] ( https://docs.docker.com/get-docker/ ) before you begin.
55
6- ## 1. Clone SuperStack
6+ ## Get SuperStack
77
8- ``` sh
9- git clone https://github.com/explodinglabs/superstack myapp
10- cd myapp
11- ```
8+ ### Option 1: Use the Template (Recommended)
9+
10+ The easiest way to get started:
1211
13- < details >
14- < summary >Click here to see how to change this clone to point "origin" to your own hosted repository (Recommended)</ summary >
12+ Click [ Use this template ] ( https://github.com/explodinglabs/superstack/generate )
13+ and create a new repository (e.g. ` myapp ` ) on GitHub.
1514
16- Rename "origin" to "upstream" :
15+ Clone your new repository :
1716
1817``` sh
19- git remote rename origin upstream
18+ git clone https://github.com/yourname/myapp.git
19+ cd myapp
2020```
2121
22- This way you can still upgrade to a more recent SuperStack with:
22+ ### Option 2: Clone and Track Upstream (Advanced)
23+
24+ If you want to keep SuperStack’s Git history and pull upstream changes later:
2325
2426``` sh
25- git pull upstream main
27+ git clone https://github.com/explodinglabs/superstack.git myapp
28+ cd myapp
2629```
2730
28- Add your own code repository :
31+ Create your own repo at [ https://github.com/new ] ( https://github.com/new ) , then :
2932
3033``` sh
31- git remote add origin https://github.com/yourname/myapp
34+ git remote rename origin upstream
35+ git remote add origin https://github.com/yourname/myapp.git
36+ git push -u origin main
3237```
3338
34- Now you can pull/push to your own repo as normal :
39+ You can now pull upstream changes with :
3540
3641``` sh
37- git pull
38- git push origin head
42+ git pull upstream main
3943```
4044
41- <h3 >Why not just fork SuperStack?</h3 >
42-
43- Because you can't make a fork private.
44-
45- <h3 >Why not make SuperStack a template repo?</h3 >
46-
47- Because then you can't pull from upstream SuperStack.
48-
49- </details >
50-
5145## 2. Configure Environment Variables
5246
5347Copy the example file:
@@ -67,8 +61,9 @@ docker compose up -d
6761
6862That's it – your backend is live.
6963
70- You can now open [ localhost:8000/openapi/] ( http://localhost:8000/openapi/ )
71- to explore your API.
64+ You can now open
65+ [ https://localhost:8000/openapi/ ] ( http://localhost:8000/openapi/ ) to explore
66+ your API.
7267
7368---
7469
0 commit comments