Skip to content

Commit 7452d2c

Browse files
committed
Adjust documentation to include template instructions
1 parent 01e6fd7 commit 7452d2c

File tree

4 files changed

+34
-53
lines changed

4 files changed

+34
-53
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,21 @@ flowchart TD
2424

2525
## 🚀 Quick Start
2626

27-
1. **Clone SuperStack and start the stack:**
27+
1. Click [Use this
28+
template](https://github.com/explodinglabs/superstack/generate) and create a
29+
new repository on Github.
30+
31+
2. Clone your new repository and start SuperStack:
2832

2933
```sh
30-
git clone https://github.com/explodinglabs/superstack myapp
34+
git clone https://github.com/yourname/myapp.git
3135
cd myapp
3236
cp example.env .env
3337
docker compose up -d
3438
```
3539

36-
2. **Explore your API**
37-
38-
Open [http://localhost:8000/openapi/](http://localhost:8000/openapi/) in your
39-
browser to view and test endpoints using Swagger UI.
40+
Open [http://localhost:8000/openapi/](http://localhost:8000/openapi/) to view
41+
your Swagger UI.
4042

4143
## 📚 Full Documentation
4244

docs/gettingstarted.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,39 @@
33
SuperStack uses Docker, so make sure [Docker is
44
installed](https://docs.docker.com/get-docker/) before you begin.
55

6-
## 1. Clone SuperStack
6+
## 1. Get SuperStack
7+
8+
### Option 1: Use the Template (Recommended)
9+
10+
The easiest way to get started:
11+
12+
1. Click [Use this
13+
template](https://github.com/explodinglabs/superstack/generate) on GitHub.
14+
2. Create a new repository (e.g. `myapp`) from the template.
15+
3. Clone it to your machine:
716

817
```sh
9-
git clone https://github.com/explodinglabs/superstack myapp
18+
git clone https://github.com/yourname/myapp.git
1019
cd myapp
1120
```
1221

13-
<details>
14-
<summary>
15-
Recommended: Change the clone to point to your own hosted repository.
16-
</summary>
22+
### Option 2: Clone and Track Upstream (Advanced)
1723

18-
Rename "origin" to "upstream":
24+
If you want to keep SuperStack’s Git history and pull upstream changes later:
1925

2026
```sh
27+
git clone https://github.com/explodinglabs/superstack.git myapp
28+
cd myapp
2129
git remote rename origin upstream
30+
git remote add origin https://github.com/yourname/myapp
2231
```
2332

24-
This way you can still upgrade to a more recent SuperStack with:
33+
You can now pull upstream changes with:
2534

2635
```sh
2736
git pull upstream main
2837
```
2938

30-
Add your own code repository:
31-
32-
```sh
33-
git remote add origin https://github.com/yourname/myapp
34-
```
35-
36-
Now you can pull/push to your own repo as normal:
37-
38-
<h3>Why not just fork SuperStack?</h3>
39-
40-
Because you can't make a fork private.
41-
42-
<h3>Why not make SuperStack a template repo?</h3>
43-
44-
Because then you can't pull from upstream SuperStack.
45-
46-
</details>
47-
4839
## 2. Configure Environment Variables
4940

5041
Copy the example file:
@@ -53,8 +44,8 @@ Copy the example file:
5344
cp example.env .env
5445
```
5546

56-
> ⚠️ The `.env` file is for local development only, don't write secrets to a
57-
> file on other environments.
47+
> ⚠️ **The .env file is for local development only.** Don't store real secrets
48+
> in production — use CI/CD environment variables or a secrets manager.
5849
5950
## 3. Start the Stack
6051

docs/index.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,6 @@ Caddy), making it easy to develop locally or deploy remotely.
2525

2626
---
2727

28-
## 📚 Documentation
29-
30-
- [Getting Started](gettingstarted.md)
31-
- [Migrations](migrations.md)
32-
- [Postgres Extensions](extensions.md)
33-
- [Authentication](authentication.md)
34-
- [Psql](psql.md)
35-
- [Deploying to Remote Environments](deploying.md)
28+
## 📚 Get Started
29+
30+
👉 [Continue to Getting Started](gettingstarted.md)

docs/psql.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
11
# 🖥️ Using psql
22

3-
`psql` is the command-line tool for interacting with your PostgreSQL
4-
database. SuperStack makes it easy to run psql inside the container using a
5-
helper script.
3+
`psql` is the command-line tool for interacting with your PostgreSQL database.
4+
SuperStack makes it easy to run psql inside the container using a helper
5+
script.
66

77
## 📟 Open a psql Shell
88

99
To connect interactively:
1010

1111
```sh
12-
bin/postgres psql
13-
```
14-
15-
Example output:
16-
17-
```
12+
$ bin/postgres psql
1813
psql (17.5 (Debian 17.5-1.pgdg120+1))
1914
Type "help" for help.
2015

2116
app=#
2217
```
2318

24-
## 🔹 Run Inline SQL Commands
25-
2619
You can also run SQL directly from the command line:
2720

2821
```

0 commit comments

Comments
 (0)