|
164 | 164 | </label> |
165 | 165 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> |
166 | 166 | <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"> |
168 | 168 | <span class="md-ellipsis"> |
169 | | - 1. Clone SuperStack |
| 169 | + 1. Get SuperStack |
170 | 170 | </span> |
171 | 171 | </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> |
172 | 190 | </li> |
173 | 191 | <li class="md-nav__item"> |
174 | 192 | <a class="md-nav__link" href="#2-configure-environment-variables"> |
|
322 | 340 | </label> |
323 | 341 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> |
324 | 342 | <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"> |
326 | 359 | <span class="md-ellipsis"> |
327 | | - 1. Clone SuperStack |
| 360 | + Option 2: Clone and Track Upstream (Advanced) |
328 | 361 | </span> |
329 | 362 | </a> |
330 | 363 | </li> |
| 364 | +</ul> |
| 365 | +</nav> |
| 366 | +</li> |
331 | 367 | <li class="md-nav__item"> |
332 | 368 | <a class="md-nav__link" href="#2-configure-environment-variables"> |
333 | 369 | <span class="md-ellipsis"> |
|
380 | 416 | <h1 id="getting-started">🚀 Getting Started</h1> |
381 | 417 | <p>SuperStack uses Docker, so make sure <a href="https://docs.docker.com/get-docker/">Docker is |
382 | 418 | 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 |
385 | 429 | <span class="nb">cd</span><span class="w"> </span>myapp |
386 | 430 | </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 |
395 | 437 | </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> |
399 | 439 | <div class="highlight"><pre><span></span><code>git<span class="w"> </span>pull<span class="w"> </span>upstream<span class="w"> </span>main |
400 | 440 | </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> |
418 | 441 | <h2 id="2-configure-environment-variables">2. Configure Environment Variables</h2> |
419 | 442 | <p>Copy the example file:</p> |
420 | 443 | <div class="highlight"><pre><span></span><code>cp<span class="w"> </span>example.env<span class="w"> </span>.env |
421 | 444 | </code></pre></div> |
422 | 445 | <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> |
425 | 448 | </blockquote> |
426 | 449 | <h2 id="3-start-the-stack">3. Start the Stack</h2> |
427 | 450 | <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d |
|
0 commit comments