|
2 | 2 | <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> |
3 | 3 |
|
4 | 4 | <meta charset="utf-8"> |
5 | | -<meta name="generator" content="quarto-1.6.39"> |
| 5 | +<meta name="generator" content="quarto-1.6.40"> |
6 | 6 |
|
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> |
8 | 8 |
|
|
69 | 69 | <script src="../site_libs/quarto-html/tippy.umd.min.js"></script> |
70 | 70 | <script src="../site_libs/quarto-html/anchor.min.js"></script> |
71 | 71 | <link href="../site_libs/quarto-html/tippy.css" rel="stylesheet"> |
72 | | -<link href="../site_libs/quarto-html/quarto-syntax-highlighting-e26003cea8cd680ca0c55a263523d882.css" rel="stylesheet" id="quarto-text-highlighting-styles"> |
| 72 | +<link href="../site_libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles"> |
73 | 73 | <script src="../site_libs/bootstrap/bootstrap.min.js"></script> |
74 | 74 | <link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet"> |
75 | | -<link href="../site_libs/bootstrap/bootstrap-ce8de41c5dcf49f81f95ec2a54f3a28e.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light"> |
| 75 | +<link href="../site_libs/bootstrap/bootstrap-5c67a7444eebc356e54fdce0a63e8750.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light"> |
76 | 76 | <script id="quarto-search-options" type="application/json">{ |
77 | 77 | "location": "navbar", |
78 | 78 | "copy-button": false, |
|
173 | 173 | <h2 id="toc-title">On this page</h2> |
174 | 174 |
|
175 | 175 | <ul> |
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> |
| 176 | + <li><a href="#install-all-development-dependencies-in-a-vscode-dev-container" id="toc-install-all-development-dependencies-in-a-vscode-dev-container" class="nav-link active" data-scroll-target="#install-all-development-dependencies-in-a-vscode-dev-container">Install all development dependencies in a VSCode Dev Container</a></li> |
177 | 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> |
178 | 178 | <ul class="collapse"> |
179 | 179 | <li><a href="#uv" id="toc-uv" class="nav-link" data-scroll-target="#uv">uv</a></li> |
@@ -217,13 +217,13 @@ <h1 class="title">Installation</h1> |
217 | 217 | </header> |
218 | 218 |
|
219 | 219 |
|
220 | | -<section id="install-all-dependencies-in-a-vscode-dev-container" class="level2"> |
221 | | -<h2 class="anchored" data-anchor-id="install-all-dependencies-in-a-vscode-dev-container">Install all dependencies in a VSCode Dev Container</h2> |
222 | | -<p>If you use VSCode with Docker to develop in a container, the following VSCode Dev Container configuration will install all dependencies:</p> |
| 220 | +<section id="install-all-development-dependencies-in-a-vscode-dev-container" class="level2"> |
| 221 | +<h2 class="anchored" data-anchor-id="install-all-development-dependencies-in-a-vscode-dev-container">Install all development dependencies in a VSCode Dev Container</h2> |
| 222 | +<p>If you use VSCode with Docker to develop in a container, the following VSCode Dev Container configuration will install all development dependencies:</p> |
223 | 223 | <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> |
224 | 224 | <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> |
225 | 225 | <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-bookworm"</span><span class="fu">,</span></span> |
226 | | -<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 && uv venv && uv sync"</span><span class="fu">,</span></span> |
| 226 | +<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 libwebp-dev && npm install [email protected] && npm install -g sass && npm install -g gulp && uv venv && uv sync" </span><span class=" fu" >, </span></span> |
227 | 227 | <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> |
228 | 228 | <span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">"ghcr.io/va-h/devcontainers-features/uv:1"</span><span class="fu">:</span> <span class="fu">{</span></span> |
229 | 229 | <span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">"version"</span><span class="fu">:</span> <span class="st">"latest"</span></span> |
@@ -258,7 +258,7 @@ <h3 class="anchored" data-anchor-id="docker-and-docker-compose">Docker and Docke |
258 | 258 | <section id="postgresql-headers" class="level3"> |
259 | 259 | <h3 class="anchored" data-anchor-id="postgresql-headers">PostgreSQL headers</h3> |
260 | 260 | <p>For Ubuntu/Debian:</p> |
261 | | -<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> python3-dev libpq-dev</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
| 261 | +<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> python3-dev libpq-dev libwebp-dev</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
262 | 262 | <p>For macOS:</p> |
263 | 263 | <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">brew</span> install postgresql</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
264 | 264 | <p>For Windows:</p> |
@@ -322,7 +322,8 @@ <h2 class="anchored" data-anchor-id="start-development-database">Start developme |
322 | 322 | <h2 class="anchored" data-anchor-id="run-the-development-server">Run the development server</h2> |
323 | 323 | <p>Before running the development server, make sure the development database is running and tables and default permissions/roles are created first. Then run the following command in your terminal from the root directory:</p> |
324 | 324 | <div class="sourceCode" id="cb14"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uvicorn</span> main:app <span class="at">--host</span> 0.0.0.0 <span class="at">--port</span> 8000 <span class="at">--reload</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> |
325 | | -<p>Navigate to http://localhost:8000/</p> |
| 325 | +<p>Navigate to http://localhost:8000/.</p> |
| 326 | +<p>(Note: If startup fails with a sqlalchemy/psycopg2 connection error, make sure that Docker Desktop and the database service are running and that the environment variables in the <code>.env</code> file are correctly populated, and then try again.)</p> |
326 | 327 | </section> |
327 | 328 | <section id="lint-types-with-mypy" class="level2"> |
328 | 329 | <h2 class="anchored" data-anchor-id="lint-types-with-mypy">Lint types with mypy</h2> |
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments