344344 </ span >
345345 </ a >
346346
347- < nav class ="md-nav " aria-label ="1. Get SuperStack ">
348- < ul class ="md-nav__list ">
349-
350- < li class ="md-nav__item ">
351- < a href ="#option-1-use-the-template-easiest " class ="md-nav__link ">
352- < span class ="md-ellipsis ">
353- Option 1: Use the Template (Easiest)
354- </ span >
355- </ a >
356-
357- </ li >
358-
359- < li class ="md-nav__item ">
360- < a href ="#option-2-clone-and-track-upstream-advanced " class ="md-nav__link ">
361- < span class ="md-ellipsis ">
362- Option 2: Clone and Track Upstream (Advanced)
363- </ span >
364- </ a >
365-
366- </ li >
367-
368- </ ul >
369- </ nav >
370-
371347</ li >
372348
373349 < li class ="md-nav__item ">
482458 </ span >
483459 </ a >
484460
485- < nav class ="md-nav " aria-label ="1. Get SuperStack ">
486- < ul class ="md-nav__list ">
487-
488- < li class ="md-nav__item ">
489- < a href ="#option-1-use-the-template-easiest " class ="md-nav__link ">
490- < span class ="md-ellipsis ">
491- Option 1: Use the Template (Easiest)
492- </ span >
493- </ a >
494-
495- </ li >
496-
497- < li class ="md-nav__item ">
498- < a href ="#option-2-clone-and-track-upstream-advanced " class ="md-nav__link ">
499- < span class ="md-ellipsis ">
500- Option 2: Clone and Track Upstream (Advanced)
501- </ span >
502- </ a >
503-
504- </ li >
505-
506- </ ul >
507- </ nav >
508-
509461</ li >
510462
511463 < li class ="md-nav__item ">
@@ -567,27 +519,12 @@ <h1 id="getting-started">🚀 Getting Started</h1>
567519< p > SuperStack uses Docker, so make sure < a href ="https://docs.docker.com/get-docker/ "> Docker is
568520installed</ a > before you begin.</ p >
569521< h2 id ="1-get-superstack "> 1. Get SuperStack</ h2 >
570- < h3 id ="option-1-use-the-template-easiest "> Option 1: Use the Template (Easiest)</ h3 >
571522< p > Click < a href ="https://github.com/explodinglabs/superstack/generate "> Use this template</ a >
572523and create a new repository (e.g. < code > myapp-backend</ code > ) on GitHub.</ p >
573524< p > Clone it to your machine:</ p >
574525< div class ="highlight "> < pre > < span > </ span > < code > git< span class ="w "> </ span > clone< span class ="w "> </ span > https://github.com/yourname/myapp-backend.git
575526< span class ="nb "> cd</ span > < span class ="w "> </ span > myapp-backend
576527</ code > </ pre > </ div >
577- < h3 id ="option-2-clone-and-track-upstream-advanced "> Option 2: Clone and Track Upstream (Advanced)</ h3 >
578- < p > If you want to keep SuperStack’s Git history and pull upstream changes later,
579- clone SuperStack:</ p >
580- < 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-backend
581- < span class ="nb "> cd</ span > < span class ="w "> </ span > myapp-backend
582- </ code > </ pre > </ div >
583- < p > < a href ="https://github.com/new "> Create your own repo</ a > , then:</ p >
584- < 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
585- 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-backend.git
586- git< span class ="w "> </ span > push< span class ="w "> </ span > -u< span class ="w "> </ span > origin< span class ="w "> </ span > main
587- </ code > </ pre > </ div >
588- < p > You can now pull upstream changes with:</ p >
589- < div class ="highlight "> < pre > < span > </ span > < code > git< span class ="w "> </ span > pull< span class ="w "> </ span > upstream< span class ="w "> </ span > main
590- </ code > </ pre > </ div >
591528< h2 id ="2-configure-environment-variables "> 2. Configure Environment Variables</ h2 >
592529< p > Copy the example environment file:</ p >
593530< div class ="highlight "> < pre > < span > </ span > < code > < span class ="nb "> cd</ span > < span class ="w "> </ span > app
@@ -600,14 +537,15 @@ <h2 id="2-configure-environment-variables">2. Configure Environment Variables</h
600537< h2 id ="3-start-the-app "> 3. Start the App</ h2 >
601538< div class ="highlight "> < pre > < span > </ span > < code > docker< span class ="w "> </ span > compose< span class ="w "> </ span > up< span class ="w "> </ span > -d
602539</ code > </ pre > </ div >
603- < p > That's it – your backend is live .</ p >
540+ < p > That's it – your backend is ready for development .</ p >
604541< p > Test it with:</ p >
605- < div class ="highlight "> < pre > < span > </ span > < code > $< span class ="w "> </ span > curl< span class ="w "> </ span > http://localhost:8000/healthcheck
542+ < div class ="highlight "> < pre > < span > </ span > < code > $< span class ="w "> </ span > curl< span class ="w "> </ span > http://localhost:8000/healthz
606543OK
607544</ code > </ pre > </ div >
608545< hr />
609546< h2 id ="whats-next "> ➕ What's Next?</ h2 >
610- < p > 👉 < a href ="../deploy/ "> Deploy to a remote environment</ a > </ p >
547+ < p > 👉 < a href ="https://github.com/explodinglabs/superstack/wiki "> Add services by following the Wiki</ a > < br />
548+ 👉 < a href ="../deploy/ "> Deploy to a remote environment</ a > </ p >
611549
612550
613551
0 commit comments