|
1 | 1 | # π Getting Started |
2 | 2 |
|
3 | | -<video controls width="100%"> |
| 3 | +<!--video controls width="100%"> |
4 | 4 | <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" |
7 | 7 | hidden> |
8 | 8 | </data> |
9 | 9 | Your browser does not support the video tag. |
10 | | -</video> |
| 10 | +</video--> |
11 | 11 |
|
12 | 12 | SuperStack uses Docker, so make sure [Docker is |
13 | 13 | installed](https://docs.docker.com/get-docker/) before you begin. |
@@ -55,35 +55,31 @@ git pull upstream main |
55 | 55 | Copy the example environment file: |
56 | 56 |
|
57 | 57 | ```sh |
58 | | -cp app/example.env app/.env |
| 58 | +cd app |
| 59 | +cp example.env .env |
59 | 60 | ``` |
60 | 61 |
|
61 | | -This `.env` file is used to set secrets, passwords, keys, etc. |
| 62 | +The `.env` file is used to set secrets, passwords, keys, etc. |
62 | 63 |
|
63 | 64 | > β οΈ Never store secrets in version control. |
64 | 65 |
|
65 | | -## 3. Start the Stack |
| 66 | +## 3. Start the App |
66 | 67 |
|
67 | 68 | ```sh |
68 | 69 | docker compose up -d |
69 | 70 | ``` |
70 | 71 |
|
71 | 72 | That's it β your backend is live. |
72 | 73 |
|
73 | | ---- |
74 | | - |
75 | | -## π§© What Just Happened? |
76 | | - |
77 | | -SuperStack automatically: |
| 74 | +Test it with: |
78 | 75 |
|
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 | +``` |
83 | 80 |
|
84 | | -> π‘ Only Caddy exposes a port β all services are routed through it. |
| 81 | +--- |
85 | 82 |
|
86 | 83 | ## β What's Next? |
87 | 84 |
|
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) |
0 commit comments