Skip to content

Commit fd6f892

Browse files
author
Exploding Labs Bot
committed
Update site from docs source repo
1 parent 80da4c6 commit fd6f892

File tree

2 files changed

+60
-37
lines changed

2 files changed

+60
-37
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="#get-superstack">
168168
<span class="md-ellipsis">
169-
1. Clone SuperStack
169+
Get SuperStack
170170
</span>
171171
</a>
172+
<nav aria-label="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">
@@ -297,12 +315,30 @@
297315
</label>
298316
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
299317
<li class="md-nav__item">
300-
<a class="md-nav__link" href="#1-clone-superstack">
318+
<a class="md-nav__link" href="#get-superstack">
319+
<span class="md-ellipsis">
320+
Get SuperStack
321+
</span>
322+
</a>
323+
<nav aria-label="Get SuperStack" class="md-nav">
324+
<ul class="md-nav__list">
325+
<li class="md-nav__item">
326+
<a class="md-nav__link" href="#option-1-use-the-template-recommended">
327+
<span class="md-ellipsis">
328+
Option 1: Use the Template (Recommended)
329+
</span>
330+
</a>
331+
</li>
332+
<li class="md-nav__item">
333+
<a class="md-nav__link" href="#option-2-clone-and-track-upstream-advanced">
301334
<span class="md-ellipsis">
302-
1. Clone SuperStack
335+
Option 2: Clone and Track Upstream (Advanced)
303336
</span>
304337
</a>
305338
</li>
339+
</ul>
340+
</nav>
341+
</li>
306342
<li class="md-nav__item">
307343
<a class="md-nav__link" href="#2-configure-environment-variables">
308344
<span class="md-ellipsis">
@@ -348,42 +384,28 @@
348384
<h1 id="getting-started">🚀 Getting Started</h1>
349385
<p>SuperStack uses Docker, so make sure <a href="https://docs.docker.com/get-docker/">Docker is
350386
installed</a> before you begin.</p>
351-
<h2 id="1-clone-superstack">1. Clone SuperStack</h2>
352-
<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
387+
<h2 id="get-superstack">Get SuperStack</h2>
388+
<h3 id="option-1-use-the-template-recommended">Option 1: Use the Template (Recommended)</h3>
389+
<p>The easiest way to get started:</p>
390+
<p>Click <a href="https://github.com/explodinglabs/superstack/generate">Use this template</a>
391+
and create a new repository (e.g. <code>myapp</code>) on GitHub.</p>
392+
<p>Clone your new repository:</p>
393+
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/yourname/myapp.git
353394
<span class="nb">cd</span><span class="w"> </span>myapp
354395
</code></pre></div>
355-
<details>
356-
<summary>Click here to see how to change this clone to point "origin" to your own hosted repository (Recommended)</summary>
357-
358-
Rename "origin" to "upstream":
359-
396+
<h3 id="option-2-clone-and-track-upstream-advanced">Option 2: Clone and Track Upstream (Advanced)</h3>
397+
<p>If you want to keep SuperStack’s Git history and pull upstream changes later:</p>
398+
<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
399+
<span class="nb">cd</span><span class="w"> </span>myapp
400+
</code></pre></div>
401+
<p>Create your own repo at <a href="https://github.com/new">https://github.com/new</a>, then:</p>
360402
<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
403+
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.git
404+
git<span class="w"> </span>push<span class="w"> </span>-u<span class="w"> </span>origin<span class="w"> </span>main
361405
</code></pre></div>
362-
363-
This way you can still upgrade to a more recent SuperStack with:
364-
406+
<p>You can now pull upstream changes with:</p>
365407
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>pull<span class="w"> </span>upstream<span class="w"> </span>main
366408
</code></pre></div>
367-
368-
Add your own code repository:
369-
370-
<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
371-
</code></pre></div>
372-
373-
Now you can pull/push to your own repo as normal:
374-
375-
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>pull
376-
git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>head
377-
</code></pre></div>
378-
<h3>Why not just fork SuperStack?</h3>
379-
380-
Because you can't make a fork private.
381-
382-
<h3>Why not make SuperStack a template repo?</h3>
383-
384-
Because then you can't pull from upstream SuperStack.
385-
386-
</details>
387409
<h2 id="2-configure-environment-variables">2. Configure Environment Variables</h2>
388410
<p>Copy the example file:</p>
389411
<div class="highlight"><pre><span></span><code>cp<span class="w"> </span>example.env<span class="w"> </span>.env
@@ -396,8 +418,9 @@ <h2 id="3-start-the-stack">3. Start the Stack</h2>
396418
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
397419
</code></pre></div>
398420
<p>That's it – your backend is live.</p>
399-
<p>You can now open <a href="http://localhost:8000/openapi/">localhost:8000/openapi/</a>
400-
to explore your API.</p>
421+
<p>You can now open
422+
<a href="http://localhost:8000/openapi/">https://localhost:8000/openapi/</a> to explore
423+
your API.</p>
401424
<hr/>
402425
<h2 id="what-just-happened">🧩 What Just Happened?</h2>
403426
<p>SuperStack automatically:</p>

0 commit comments

Comments
 (0)