Skip to content

Commit 0bdf294

Browse files
committed
Improve getting started doc
1 parent 663e824 commit 0bdf294

File tree

4 files changed

+22
-33
lines changed

4 files changed

+22
-33
lines changed

β€Ždocs/deploy.mdβ€Ž

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,9 @@ page on [Advanced Deployments]().
6565
## Github Actions Workflow
6666

6767
TODO
68+
69+
---
70+
71+
## βž• What Now?
72+
73+
Add to your app by following guides in the [Wiki](https://github.com/explodinlabs/superstack/wiki).

β€Ždocs/gettingstarted.mdβ€Ž

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# πŸš€ Getting Started
22

3-
<video controls width="100%">
3+
<!--video controls width="100%">
44
<source src="/superstack/assets/getting-started.mp4" type="video/mp4">
5-
<data
6-
value="Music: Bensound, License: UZG5X7IWWLQOQEU1, Artist: Lunar Years"
5+
<data
6+
value="Music: Bensound, License: UZG5X7IWWLQOQEU1, Artist: Lunar Years"
77
hidden>
88
</data>
99
Your browser does not support the video tag.
10-
</video>
10+
</video-->
1111

1212
SuperStack uses Docker, so make sure [Docker is
1313
installed](https://docs.docker.com/get-docker/) before you begin.
@@ -55,35 +55,31 @@ git pull upstream main
5555
Copy the example environment file:
5656

5757
```sh
58-
cp app/example.env app/.env
58+
cd app
59+
cp example.env .env
5960
```
6061

61-
This `.env` file is used to set secrets, passwords, keys, etc.
62+
The `.env` file is used to set secrets, passwords, keys, etc.
6263

6364
> ⚠️ Never store secrets in version control.
6465
65-
## 3. Start the Stack
66+
## 3. Start the App
6667

6768
```sh
6869
docker compose up -d
6970
```
7071

7172
That's it – your backend is live.
7273

73-
---
74-
75-
## 🧩 What Just Happened?
76-
77-
SuperStack automatically:
74+
Test it with:
7875

79-
1. Starts a fresh Postgres database
80-
2. Applies initial migrations
81-
3. Launches PostgREST
82-
4. Serves everything through Caddy
76+
```sh
77+
$ curl http://localhost:8000/healthcheck
78+
OK
79+
```
8380

84-
> πŸ’‘ Only Caddy exposes a port – all services are routed through it.
81+
---
8582

8683
## βž• What's Next?
8784

88-
πŸ‘‰ [Create your database schema with migrations](migrations.md)
89-
πŸ‘‰ [Deploy to a remote environment](deploying.md)
85+
πŸ‘‰ [Deploy to a remote environment](deploy.md)

β€Ždocs/structure.mdβ€Ž

Lines changed: 0 additions & 13 deletions
This file was deleted.

β€Žmkdocs.ymlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ markdown_extensions:
4848
nav:
4949
- Home: index.md
5050
- Getting Started: gettingstarted.md
51-
- Deploying to Remote Environments: deploying.md
51+
- Deploying to Remote Environments: deploy.md

0 commit comments

Comments
Β (0)