Skip to content

Commit b8a6e1f

Browse files
author
Exploding Labs Bot
committed
Update site from docs source repo
1 parent 103e6c1 commit b8a6e1f

File tree

8 files changed

+181
-499
lines changed

8 files changed

+181
-499
lines changed

‎superstack/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@
299299

300300

301301
<li class="md-nav__item">
302-
<a href="/superstack/deploying.md" class="md-nav__link">
302+
<a href="/superstack/deploy/" class="md-nav__link">
303303

304304

305305

‎superstack/deploy/index.html‎

Lines changed: 142 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@
1111
<link rel="canonical" href="https://explodinglabs.com/superstack/deploy/">
1212

1313

14+
<link rel="prev" href="../gettingstarted/">
15+
1416

1517

1618
<link rel="icon" href="../assets/images/favicon.png">
1719
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
1820

1921

2022

21-
<title>☁️ Deploying to Remote Environments - SuperStack</title>
23+
<title>Deploying to Remote Environments - SuperStack</title>
2224

2325

2426

@@ -107,7 +109,7 @@
107109
<div class="md-header__topic" data-md-component="header-topic">
108110
<span class="md-ellipsis">
109111

110-
☁️ Deploying to Remote Environments
112+
Deploying to Remote Environments
111113

112114
</span>
113115
</div>
@@ -303,10 +305,32 @@
303305

304306

305307

308+
309+
306310

307311

308-
<li class="md-nav__item">
309-
<a href="../deploying.md" class="md-nav__link">
312+
<li class="md-nav__item md-nav__item--active">
313+
314+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
315+
316+
317+
318+
319+
320+
<label class="md-nav__link md-nav__link--active" for="__toc">
321+
322+
323+
324+
<span class="md-ellipsis">
325+
Deploying to Remote Environments
326+
327+
</span>
328+
329+
330+
<span class="md-nav__icon md-icon"></span>
331+
</label>
332+
333+
<a href="./" class="md-nav__link md-nav__link--active">
310334

311335

312336

@@ -317,6 +341,86 @@
317341

318342

319343
</a>
344+
345+
346+
347+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
348+
349+
350+
351+
352+
353+
354+
<label class="md-nav__title" for="__toc">
355+
<span class="md-nav__icon md-icon"></span>
356+
Table of contents
357+
</label>
358+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
359+
360+
<li class="md-nav__item">
361+
<a href="#prepare-your-application" class="md-nav__link">
362+
<span class="md-ellipsis">
363+
Prepare your Application
364+
</span>
365+
</a>
366+
367+
</li>
368+
369+
<li class="md-nav__item">
370+
<a href="#deploy" class="md-nav__link">
371+
<span class="md-ellipsis">
372+
📦 Deploy
373+
</span>
374+
</a>
375+
376+
<nav class="md-nav" aria-label="📦 Deploy">
377+
<ul class="md-nav__list">
378+
379+
<li class="md-nav__item">
380+
<a href="#secrets" class="md-nav__link">
381+
<span class="md-ellipsis">
382+
Secrets
383+
</span>
384+
</a>
385+
386+
</li>
387+
388+
</ul>
389+
</nav>
390+
391+
</li>
392+
393+
<li class="md-nav__item">
394+
<a href="#launch-your-stack" class="md-nav__link">
395+
<span class="md-ellipsis">
396+
🚀 Launch your Stack
397+
</span>
398+
</a>
399+
400+
</li>
401+
402+
<li class="md-nav__item">
403+
<a href="#github-actions-workflow" class="md-nav__link">
404+
<span class="md-ellipsis">
405+
Github Actions Workflow
406+
</span>
407+
</a>
408+
409+
</li>
410+
411+
<li class="md-nav__item">
412+
<a href="#what-now" class="md-nav__link">
413+
<span class="md-ellipsis">
414+
➕ What Now?
415+
</span>
416+
</a>
417+
418+
</li>
419+
420+
</ul>
421+
422+
</nav>
423+
320424
</li>
321425

322426

@@ -396,6 +500,15 @@
396500
</span>
397501
</a>
398502

503+
</li>
504+
505+
<li class="md-nav__item">
506+
<a href="#what-now" class="md-nav__link">
507+
<span class="md-ellipsis">
508+
➕ What Now?
509+
</span>
510+
</a>
511+
399512
</li>
400513

401514
</ul>
@@ -461,6 +574,9 @@ <h2 id="launch-your-stack">🚀 Launch your Stack</h2>
461574
page on <a href="">Advanced Deployments</a>.</p>
462575
<h2 id="github-actions-workflow">Github Actions Workflow</h2>
463576
<p>TODO</p>
577+
<hr />
578+
<h2 id="what-now">➕ What Now?</h2>
579+
<p>Add to your app by following guides in the <a href="https://github.com/explodinlabs/superstack/wiki">Wiki</a>.</p>
464580

465581

466582

@@ -486,6 +602,28 @@ <h2 id="github-actions-workflow">Github Actions Workflow</h2>
486602
<footer class="md-footer">
487603

488604

605+
606+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
607+
608+
609+
<a href="../gettingstarted/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Getting Started">
610+
<div class="md-footer__button md-icon">
611+
612+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
613+
</div>
614+
<div class="md-footer__title">
615+
<span class="md-footer__direction">
616+
Previous
617+
</span>
618+
<div class="md-ellipsis">
619+
Getting Started
620+
</div>
621+
</div>
622+
</a>
623+
624+
625+
</nav>
626+
489627

490628
<div class="md-footer-meta md-typeset">
491629
<div class="md-footer-meta__inner md-grid">

‎superstack/gettingstarted/index.html‎

Lines changed: 36 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
<link rel="prev" href="..">
1515

1616

17+
<link rel="next" href="../deploy/">
18+
1719

1820
<link rel="icon" href="../assets/images/favicon.png">
1921
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
@@ -378,18 +380,9 @@
378380
</li>
379381

380382
<li class="md-nav__item">
381-
<a href="#3-start-the-stack" class="md-nav__link">
382-
<span class="md-ellipsis">
383-
3. Start the Stack
384-
</span>
385-
</a>
386-
387-
</li>
388-
389-
<li class="md-nav__item">
390-
<a href="#what-just-happened" class="md-nav__link">
383+
<a href="#3-start-the-app" class="md-nav__link">
391384
<span class="md-ellipsis">
392-
🧩 What Just Happened?
385+
3. Start the App
393386
</span>
394387
</a>
395388

@@ -419,7 +412,7 @@
419412

420413

421414
<li class="md-nav__item">
422-
<a href="../deploying.md" class="md-nav__link">
415+
<a href="../deploy/" class="md-nav__link">
423416

424417

425418

@@ -503,18 +496,9 @@
503496
</li>
504497

505498
<li class="md-nav__item">
506-
<a href="#3-start-the-stack" class="md-nav__link">
507-
<span class="md-ellipsis">
508-
3. Start the Stack
509-
</span>
510-
</a>
511-
512-
</li>
513-
514-
<li class="md-nav__item">
515-
<a href="#what-just-happened" class="md-nav__link">
499+
<a href="#3-start-the-app" class="md-nav__link">
516500
<span class="md-ellipsis">
517-
🧩 What Just Happened?
501+
3. Start the App
518502
</span>
519503
</a>
520504

@@ -549,14 +533,14 @@
549533

550534

551535
<h1 id="getting-started">🚀 Getting Started</h1>
552-
<video controls width="100%">
536+
<!--video controls width="100%">
553537
<source src="/superstack/assets/getting-started.mp4" type="video/mp4">
554-
<data
555-
value="Music: Bensound, License: UZG5X7IWWLQOQEU1, Artist: Lunar Years"
538+
<data
539+
value="Music: Bensound, License: UZG5X7IWWLQOQEU1, Artist: Lunar Years"
556540
hidden>
557541
</data>
558542
Your browser does not support the video tag.
559-
</video>
543+
</video-->
560544

561545
<p>SuperStack uses Docker, so make sure <a href="https://docs.docker.com/get-docker/">Docker is
562546
installed</a> before you begin.</p>
@@ -584,31 +568,24 @@ <h3 id="option-2-clone-and-track-upstream-advanced">Option 2: Clone and Track Up
584568
</code></pre></div>
585569
<h2 id="2-configure-environment-variables">2. Configure Environment Variables</h2>
586570
<p>Copy the example environment file:</p>
587-
<div class="highlight"><pre><span></span><code>cp<span class="w"> </span>app/example.env<span class="w"> </span>app/.env
571+
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>app
572+
cp<span class="w"> </span>example.env<span class="w"> </span>.env
588573
</code></pre></div>
589-
<p>This <code>.env</code> file is used to set secrets, passwords, keys, etc.</p>
574+
<p>The <code>.env</code> file is used to set secrets, passwords, keys, etc.</p>
590575
<blockquote>
591576
<p>⚠️ Never store secrets in version control.</p>
592577
</blockquote>
593-
<h2 id="3-start-the-stack">3. Start the Stack</h2>
578+
<h2 id="3-start-the-app">3. Start the App</h2>
594579
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
595580
</code></pre></div>
596581
<p>That's it – your backend is live.</p>
582+
<p>Test it with:</p>
583+
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>curl<span class="w"> </span>http://localhost:8000/healthcheck
584+
OK
585+
</code></pre></div>
597586
<hr />
598-
<h2 id="what-just-happened">🧩 What Just Happened?</h2>
599-
<p>SuperStack automatically:</p>
600-
<ol>
601-
<li>Starts a fresh Postgres database</li>
602-
<li>Applies initial migrations</li>
603-
<li>Launches PostgREST</li>
604-
<li>Serves everything through Caddy</li>
605-
</ol>
606-
<blockquote>
607-
<p>💡 Only Caddy exposes a port – all services are routed through it.</p>
608-
</blockquote>
609587
<h2 id="whats-next">➕ What's Next?</h2>
610-
<p>👉 <a href="migrations.md">Create your database schema with migrations</a><br />
611-
👉 <a href="deploying.md">Deploy to a remote environment</a></p>
588+
<p>👉 <a href="../deploy/">Deploy to a remote environment</a></p>
612589

613590

614591

@@ -654,6 +631,22 @@ <h2 id="whats-next">➕ What's Next?</h2>
654631
</a>
655632

656633

634+
635+
<a href="../deploy/" class="md-footer__link md-footer__link--next" aria-label="Next: Deploying to Remote Environments">
636+
<div class="md-footer__title">
637+
<span class="md-footer__direction">
638+
Next
639+
</span>
640+
<div class="md-ellipsis">
641+
Deploying to Remote Environments
642+
</div>
643+
</div>
644+
<div class="md-footer__button md-icon">
645+
646+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
647+
</div>
648+
</a>
649+
657650
</nav>
658651

659652

‎superstack/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@
368368

369369

370370
<li class="md-nav__item">
371-
<a href="deploying.md" class="md-nav__link">
371+
<a href="deploy/" class="md-nav__link">
372372

373373

374374

0 commit comments

Comments
 (0)