Skip to content

Commit 9b06d84

Browse files
author
Exploding Labs Bot
committed
Update site from docs source repo
1 parent a7312f1 commit 9b06d84

File tree

4 files changed

+73
-78
lines changed

4 files changed

+73
-78
lines changed

superstack/gettingstarted/index.html

Lines changed: 59 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,29 @@
164164
</label>
165165
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
166166
<li class="md-nav__item">
167-
<a class="md-nav__link" href="#1-clone-superstack">
167+
<a class="md-nav__link" href="#1-get-superstack">
168168
<span class="md-ellipsis">
169-
1. Clone SuperStack
169+
1. Get SuperStack
170170
</span>
171171
</a>
172+
<nav aria-label="1. Get SuperStack" class="md-nav">
173+
<ul class="md-nav__list">
174+
<li class="md-nav__item">
175+
<a class="md-nav__link" href="#option-1-use-the-template-recommended">
176+
<span class="md-ellipsis">
177+
Option 1: Use the Template (Recommended)
178+
</span>
179+
</a>
180+
</li>
181+
<li class="md-nav__item">
182+
<a class="md-nav__link" href="#option-2-clone-and-track-upstream-advanced">
183+
<span class="md-ellipsis">
184+
Option 2: Clone and Track Upstream (Advanced)
185+
</span>
186+
</a>
187+
</li>
188+
</ul>
189+
</nav>
172190
</li>
173191
<li class="md-nav__item">
174192
<a class="md-nav__link" href="#2-configure-environment-variables">
@@ -322,12 +340,30 @@
322340
</label>
323341
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
324342
<li class="md-nav__item">
325-
<a class="md-nav__link" href="#1-clone-superstack">
343+
<a class="md-nav__link" href="#1-get-superstack">
344+
<span class="md-ellipsis">
345+
1. Get SuperStack
346+
</span>
347+
</a>
348+
<nav aria-label="1. Get SuperStack" class="md-nav">
349+
<ul class="md-nav__list">
350+
<li class="md-nav__item">
351+
<a class="md-nav__link" href="#option-1-use-the-template-recommended">
352+
<span class="md-ellipsis">
353+
Option 1: Use the Template (Recommended)
354+
</span>
355+
</a>
356+
</li>
357+
<li class="md-nav__item">
358+
<a class="md-nav__link" href="#option-2-clone-and-track-upstream-advanced">
326359
<span class="md-ellipsis">
327-
1. Clone SuperStack
360+
Option 2: Clone and Track Upstream (Advanced)
328361
</span>
329362
</a>
330363
</li>
364+
</ul>
365+
</nav>
366+
</li>
331367
<li class="md-nav__item">
332368
<a class="md-nav__link" href="#2-configure-environment-variables">
333369
<span class="md-ellipsis">
@@ -380,48 +416,35 @@
380416
<h1 id="getting-started">🚀 Getting Started</h1>
381417
<p>SuperStack uses Docker, so make sure <a href="https://docs.docker.com/get-docker/">Docker is
382418
installed</a> before you begin.</p>
383-
<h2 id="1-clone-superstack">1. Clone SuperStack</h2>
384-
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/explodinglabs/superstack<span class="w"> </span>myapp
419+
<h2 id="1-get-superstack">1. Get SuperStack</h2>
420+
<h3 id="option-1-use-the-template-recommended">Option 1: Use the Template (Recommended)</h3>
421+
<p>The easiest way to get started:</p>
422+
<ol>
423+
<li>Click <a href="https://github.com/explodinglabs/superstack/generate">Use this
424+
template</a> on GitHub.</li>
425+
<li>Create a new repository (e.g. <code>myapp</code>) from the template.</li>
426+
<li>Clone it to your machine:</li>
427+
</ol>
428+
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/yourname/myapp.git
385429
<span class="nb">cd</span><span class="w"> </span>myapp
386430
</code></pre></div>
387-
<details>
388-
<summary>
389-
Recommended: Change the clone to point to your own hosted repository.
390-
</summary>
391-
392-
Rename "origin" to "upstream":
393-
394-
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>remote<span class="w"> </span>rename<span class="w"> </span>origin<span class="w"> </span>upstream
431+
<h3 id="option-2-clone-and-track-upstream-advanced">Option 2: Clone and Track Upstream (Advanced)</h3>
432+
<p>If you want to keep SuperStack’s Git history and pull upstream changes later:</p>
433+
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/explodinglabs/superstack.git<span class="w"> </span>myapp
434+
<span class="nb">cd</span><span class="w"> </span>myapp
435+
git<span class="w"> </span>remote<span class="w"> </span>rename<span class="w"> </span>origin<span class="w"> </span>upstream
436+
git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>origin<span class="w"> </span>https://github.com/yourname/myapp
395437
</code></pre></div>
396-
397-
This way you can still upgrade to a more recent SuperStack with:
398-
438+
<p>You can now pull upstream changes with:</p>
399439
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>pull<span class="w"> </span>upstream<span class="w"> </span>main
400440
</code></pre></div>
401-
402-
Add your own code repository:
403-
404-
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>origin<span class="w"> </span>https://github.com/yourname/myapp
405-
</code></pre></div>
406-
407-
Now you can pull/push to your own repo as normal:
408-
409-
<h3>Why not just fork SuperStack?</h3>
410-
411-
Because you can't make a fork private.
412-
413-
<h3>Why not make SuperStack a template repo?</h3>
414-
415-
Because then you can't pull from upstream SuperStack.
416-
417-
</details>
418441
<h2 id="2-configure-environment-variables">2. Configure Environment Variables</h2>
419442
<p>Copy the example file:</p>
420443
<div class="highlight"><pre><span></span><code>cp<span class="w"> </span>example.env<span class="w"> </span>.env
421444
</code></pre></div>
422445
<blockquote>
423-
<p>⚠️ The <code>.env</code> file is for local development only, don't write secrets to a
424-
file on other environments.</p>
446+
<p>⚠️ <strong>The .env file is for local development only.</strong> Don't store real secrets
447+
in production — use CI/CD environment variables or a secrets manager.</p>
425448
</blockquote>
426449
<h2 id="3-start-the-stack">3. Start the Stack</h2>
427450
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d

superstack/index.html

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -323,9 +323,9 @@
323323
</li>
324324

325325
<li class="md-nav__item">
326-
<a href="#documentation" class="md-nav__link">
326+
<a href="#get-started" class="md-nav__link">
327327
<span class="md-ellipsis">
328-
📚 Documentation
328+
📚 Get Started
329329
</span>
330330
</a>
331331

@@ -648,9 +648,9 @@
648648
</li>
649649

650650
<li class="md-nav__item">
651-
<a href="#documentation" class="md-nav__link">
651+
<a href="#get-started" class="md-nav__link">
652652
<span class="md-ellipsis">
653-
📚 Documentation
653+
📚 Get Started
654654
</span>
655655
</a>
656656

@@ -694,15 +694,8 @@ <h2 id="what-can-i-do-with-superstack">🚀 What Can I Do with SuperStack?</h2>
694694
<p>Everything runs inside Docker and routes through a single exposed port (via
695695
Caddy), making it easy to develop locally or deploy remotely.</p>
696696
<hr />
697-
<h2 id="documentation">📚 Documentation</h2>
698-
<ul>
699-
<li><a href="gettingstarted/">Getting Started</a></li>
700-
<li><a href="migrations/">Migrations</a></li>
701-
<li><a href="extensions/">Postgres Extensions</a></li>
702-
<li><a href="authentication/">Authentication</a></li>
703-
<li><a href="psql/">Psql</a></li>
704-
<li><a href="deploying/">Deploying to Remote Environments</a></li>
705-
</ul>
697+
<h2 id="get-started">📚 Get Started</h2>
698+
<p>👉 <a href="gettingstarted/">Continue to Getting Started</a></p>
706699

707700

708701

superstack/psql/index.html

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -406,15 +406,6 @@
406406
</span>
407407
</a>
408408

409-
</li>
410-
411-
<li class="md-nav__item">
412-
<a href="#run-inline-sql-commands" class="md-nav__link">
413-
<span class="md-ellipsis">
414-
🔹 Run Inline SQL Commands
415-
</span>
416-
</a>
417-
418409
</li>
419410

420411
<li class="md-nav__item">
@@ -709,15 +700,6 @@
709700
</span>
710701
</a>
711702

712-
</li>
713-
714-
<li class="md-nav__item">
715-
<a href="#run-inline-sql-commands" class="md-nav__link">
716-
<span class="md-ellipsis">
717-
🔹 Run Inline SQL Commands
718-
</span>
719-
</a>
720-
721703
</li>
722704

723705
<li class="md-nav__item">
@@ -800,20 +782,17 @@
800782

801783

802784
<h1 id="using-psql">🖥️ Using psql</h1>
803-
<p><code>psql</code> is the command-line tool for interacting with your PostgreSQL
804-
database. SuperStack makes it easy to run psql inside the container using a
805-
helper script.</p>
785+
<p><code>psql</code> is the command-line tool for interacting with your PostgreSQL database.
786+
SuperStack makes it easy to run psql inside the container using a helper
787+
script.</p>
806788
<h2 id="open-a-psql-shell">📟 Open a psql Shell</h2>
807789
<p>To connect interactively:</p>
808-
<div class="highlight"><pre><span></span><code>bin/postgres<span class="w"> </span>psql
809-
</code></pre></div>
810-
<p>Example output:</p>
811-
<div class="highlight"><pre><span></span><code>psql (17.5 (Debian 17.5-1.pgdg120+1))
812-
Type &quot;help&quot; for help.
790+
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>bin/postgres<span class="w"> </span>psql
791+
psql<span class="w"> </span><span class="o">(</span><span class="m">17</span>.5<span class="w"> </span><span class="o">(</span>Debian<span class="w"> </span><span class="m">17</span>.5-1.pgdg120+1<span class="o">))</span>
792+
Type<span class="w"> </span><span class="s2">&quot;help&quot;</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>help.
813793

814-
app=#
794+
<span class="nv">app</span><span class="o">=</span><span class="c1">#</span>
815795
</code></pre></div>
816-
<h2 id="run-inline-sql-commands">🔹 Run Inline SQL Commands</h2>
817796
<p>You can also run SQL directly from the command line:</p>
818797
<div class="highlight"><pre><span></span><code>bin/postgres psql -c &#39;select * from api.movie;&#39;
819798
</code></pre></div>

0 commit comments

Comments
 (0)