|
150 | 150 | <a class="nav-link" href="../docs/contributing.html">
|
151 | 151 | <span class="menu-text">Contributing</span></a>
|
152 | 152 | </li>
|
| 153 | +</ul> |
| 154 | + <ul class="navbar-nav navbar-nav-scroll ms-auto"> |
| 155 | + <li class="nav-item compact"> |
| 156 | + <a class="nav-link" href="https://github.com/promptly-technologies-llc/fastapi-jinja2-postgres-webapp"> <i class="bi bi-github" role="img"> |
| 157 | +</i> |
| 158 | +<span class="menu-text"></span></a> |
| 159 | + </li> |
153 | 160 | </ul>
|
154 | 161 | </div> <!-- /navcollapse -->
|
155 | 162 | <div class="quarto-navbar-tools">
|
|
166 | 173 | <h2 id="toc-title">On this page</h2>
|
167 | 174 |
|
168 | 175 | <ul>
|
169 |
| - <li><a href="#install-development-dependencies-in-a-vscode-dev-container" id="toc-install-development-dependencies-in-a-vscode-dev-container" class="nav-link active" data-scroll-target="#install-development-dependencies-in-a-vscode-dev-container">Install development dependencies in a VSCode Dev Container</a></li> |
| 176 | + <li><a href="#install-all-dependencies-in-a-vscode-dev-container" id="toc-install-all-dependencies-in-a-vscode-dev-container" class="nav-link active" data-scroll-target="#install-all-dependencies-in-a-vscode-dev-container">Install all dependencies in a VSCode Dev Container</a></li> |
170 | 177 | <li><a href="#install-development-dependencies-manually" id="toc-install-development-dependencies-manually" class="nav-link" data-scroll-target="#install-development-dependencies-manually">Install development dependencies manually</a>
|
171 | 178 | <ul class="collapse">
|
172 | 179 | <li><a href="#python-and-docker" id="toc-python-and-docker" class="nav-link" data-scroll-target="#python-and-docker">Python and Docker</a></li>
|
173 | 180 | <li><a href="#postgresql-headers" id="toc-postgresql-headers" class="nav-link" data-scroll-target="#postgresql-headers">PostgreSQL headers</a></li>
|
174 |
| - <li><a href="#quarto-cli-and-graphviz" id="toc-quarto-cli-and-graphviz" class="nav-link" data-scroll-target="#quarto-cli-and-graphviz">Quarto CLI and Graphviz</a></li> |
175 | 181 | <li><a href="#python-dependencies" id="toc-python-dependencies" class="nav-link" data-scroll-target="#python-dependencies">Python dependencies</a></li>
|
176 | 182 | </ul></li>
|
| 183 | + <li><a href="#install-documentation-dependencies-manually" id="toc-install-documentation-dependencies-manually" class="nav-link" data-scroll-target="#install-documentation-dependencies-manually">Install documentation dependencies manually</a> |
| 184 | + <ul class="collapse"> |
| 185 | + <li><a href="#quarto-cli" id="toc-quarto-cli" class="nav-link" data-scroll-target="#quarto-cli">Quarto CLI</a></li> |
| 186 | + <li><a href="#graphviz" id="toc-graphviz" class="nav-link" data-scroll-target="#graphviz">Graphviz</a></li> |
| 187 | + </ul></li> |
177 | 188 | <li><a href="#set-environment-variables" id="toc-set-environment-variables" class="nav-link" data-scroll-target="#set-environment-variables">Set environment variables</a></li>
|
178 | 189 | <li><a href="#start-development-database" id="toc-start-development-database" class="nav-link" data-scroll-target="#start-development-database">Start development database</a></li>
|
179 | 190 | <li><a href="#run-the-development-server" id="toc-run-the-development-server" class="nav-link" data-scroll-target="#run-the-development-server">Run the development server</a></li>
|
@@ -203,13 +214,13 @@ <h1 class="title">Installation</h1>
|
203 | 214 | </header>
|
204 | 215 |
|
205 | 216 |
|
206 |
| -<section id="install-development-dependencies-in-a-vscode-dev-container" class="level2"> |
207 |
| -<h2 class="anchored" data-anchor-id="install-development-dependencies-in-a-vscode-dev-container">Install development dependencies in a VSCode Dev Container</h2> |
| 217 | +<section id="install-all-dependencies-in-a-vscode-dev-container" class="level2"> |
| 218 | +<h2 class="anchored" data-anchor-id="install-all-dependencies-in-a-vscode-dev-container">Install all dependencies in a VSCode Dev Container</h2> |
208 | 219 | <p>If you use VSCode with Docker to develop in a container, the following VSCode Dev Container configuration will install all dependencies:</p>
|
209 | 220 | <div class="sourceCode" id="cb1"><pre class="sourceCode json code-with-copy"><code class="sourceCode json"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
|
210 | 221 | <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"Python 3"</span><span class="fu">,</span></span>
|
211 | 222 | <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"image"</span><span class="fu">:</span> <span class="st">"mcr.microsoft.com/devcontainers/python:1-3.12-bullseye"</span><span class="fu">,</span></span>
|
212 |
| -<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">"postCreateCommand"</span><span class="fu">:</span> <span class="st">"sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && pipx install poetry && poetry install && poetry shell"</span><span class="fu">,</span></span> |
| 223 | +<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">"postCreateCommand"</span><span class="fu">:</span> <span class="st">"sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && quarto add mcanouil/quarto-iconify && pipx install poetry && poetry install && poetry shell"</span><span class="fu">,</span></span> |
213 | 224 | <span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">"features"</span><span class="fu">:</span> <span class="fu">{</span></span>
|
214 | 225 | <span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">"ghcr.io/devcontainers/features/docker-outside-of-docker:1"</span><span class="fu">:</span> <span class="fu">{},</span></span>
|
215 | 226 | <span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">"ghcr.io/rocker-org/devcontainer-features/quarto-cli:1"</span><span class="fu">:</span> <span class="fu">{}</span></span>
|
@@ -237,37 +248,42 @@ <h3 class="anchored" data-anchor-id="postgresql-headers">PostgreSQL headers</h3>
|
237 | 248 | <li>No installation required</li>
|
238 | 249 | </ul>
|
239 | 250 | </section>
|
240 |
| -<section id="quarto-cli-and-graphviz" class="level3"> |
241 |
| -<h3 class="anchored" data-anchor-id="quarto-cli-and-graphviz">Quarto CLI and Graphviz</h3> |
242 |
| -<ul> |
243 |
| -<li><a href="https://quarto.org/docs/get-started/">Quarto CLI</a></li> |
244 |
| -</ul> |
245 |
| -<p>For macOS:</p> |
246 |
| -<div class="sourceCode" id="cb4"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">brew</span> install graphviz</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
247 |
| -<p>For Ubuntu/Debian:</p> |
248 |
| -<div class="sourceCode" id="cb5"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> apt update <span class="kw">&&</span> <span class="fu">sudo</span> apt install <span class="at">-y</span> graphviz</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
249 |
| -<p>For Windows:</p> |
250 |
| -<ul> |
251 |
| -<li>Download and install from <a href="https://graphviz.org/download/#windows">Graphviz.org</a></li> |
252 |
| -</ul> |
253 |
| -</section> |
254 | 251 | <section id="python-dependencies" class="level3">
|
255 | 252 | <h3 class="anchored" data-anchor-id="python-dependencies">Python dependencies</h3>
|
256 | 253 | <ol type="1">
|
257 | 254 | <li>Install Poetry</li>
|
258 | 255 | </ol>
|
259 |
| -<div class="sourceCode" id="cb6"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pipx</span> install poetry</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
| 256 | +<div class="sourceCode" id="cb4"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pipx</span> install poetry</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
260 | 257 | <ol start="2" type="1">
|
261 | 258 | <li>Install project dependencies</li>
|
262 | 259 | </ol>
|
263 |
| -<div class="sourceCode" id="cb7"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="ex">poetry</span> install</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
| 260 | +<div class="sourceCode" id="cb5"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">poetry</span> install</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
264 | 261 | <ol start="3" type="1">
|
265 | 262 | <li>Activate shell</li>
|
266 | 263 | </ol>
|
267 |
| -<div class="sourceCode" id="cb8"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">poetry</span> shell</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
| 264 | +<div class="sourceCode" id="cb6"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">poetry</span> shell</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
268 | 265 | <p>(Note: You will need to activate the shell every time you open a new terminal session. Alternatively, you can use the <code>poetry run</code> prefix before other commands to run them without activating the shell.)</p>
|
269 | 266 | </section>
|
270 | 267 | </section>
|
| 268 | +<section id="install-documentation-dependencies-manually" class="level2"> |
| 269 | +<h2 class="anchored" data-anchor-id="install-documentation-dependencies-manually">Install documentation dependencies manually</h2> |
| 270 | +<section id="quarto-cli" class="level3"> |
| 271 | +<h3 class="anchored" data-anchor-id="quarto-cli">Quarto CLI</h3> |
| 272 | +<p>To render the project documentation, you will need to download and install the <a href="https://quarto.org/docs/get-started/">Quarto CLI</a> for your operating system.</p> |
| 273 | +</section> |
| 274 | +<section id="graphviz" class="level3"> |
| 275 | +<h3 class="anchored" data-anchor-id="graphviz">Graphviz</h3> |
| 276 | +<p>Architecture diagrams in the documentation are rendered with <a href="https://graphviz.org/">Graphviz</a>.</p> |
| 277 | +<p>For macOS:</p> |
| 278 | +<div class="sourceCode" id="cb7"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="ex">brew</span> install graphviz</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
| 279 | +<p>For Ubuntu/Debian:</p> |
| 280 | +<div class="sourceCode" id="cb8"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> apt update <span class="kw">&&</span> <span class="fu">sudo</span> apt install <span class="at">-y</span> graphviz</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
| 281 | +<p>For Windows:</p> |
| 282 | +<ul> |
| 283 | +<li>Download and install from <a href="https://graphviz.org/download/#windows">Graphviz.org</a></li> |
| 284 | +</ul> |
| 285 | +</section> |
| 286 | +</section> |
271 | 287 | <section id="set-environment-variables" class="level2">
|
272 | 288 | <h2 class="anchored" data-anchor-id="set-environment-variables">Set environment variables</h2>
|
273 | 289 | <p>Copy .env.example to .env with <code>cp .env.example .env</code>.</p>
|
@@ -714,6 +730,26 @@ <h2 class="anchored" data-anchor-id="lint-types-with-mypy">Lint types with mypy<
|
714 | 730 | });
|
715 | 731 | </script>
|
716 | 732 | </div> <!-- /content -->
|
| 733 | +<footer class="footer"> |
| 734 | + <div class="nav-footer"> |
| 735 | + <div class="nav-footer-left"> |
| 736 | +<p>Copyright 2024, Promptly Technologies, LLC</p> |
| 737 | +</div> |
| 738 | + <div class="nav-footer-center"> |
| 739 | + |
| 740 | + </div> |
| 741 | + <div class="nav-footer-right"> |
| 742 | + <ul class="footer-items list-unstyled"> |
| 743 | + <li class="nav-item compact"> |
| 744 | + <a class="nav-link" href="https://github.com/promptly-technologies-llc/fastapi-jinja2-postgres-webapp"> |
| 745 | + <i class="bi bi-github" role="img"> |
| 746 | +</i> |
| 747 | + </a> |
| 748 | + </li> |
| 749 | +</ul> |
| 750 | + </div> |
| 751 | + </div> |
| 752 | +</footer> |
717 | 753 |
|
718 | 754 |
|
719 | 755 |
|
|
0 commit comments