new use_uv

Author: Ben Fitzhardinge

.devcontainer/devcontainer.json

@@ -21,5 +21,6 @@
 
   // Use 'postCreateCommand' to run commands after the container is created.
   // Note: Useful for when they open it and want everything to just start
-  "postCreateCommand": "./.devcontainer/setup.sh"
+  "postCreateCommand": "./.devcontainer/setup.sh",
+  "postStartCommand": "./.devcontainer/post_start.sh"
 }

.devcontainer/post_start.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Run the database in the background
+docker compose up -d

.devcontainer/setup.sh

@@ -25,5 +25,16 @@ fi
 (cd server && uv sync)
 (cd client && npm install)
 
+# Run the database in the background
+docker compose up -d
+
+# Wait for the database to start
+# Get the container ID of the db service
+DB_CONTAINER_ID=$(docker compose ps -q db)
+echo "Waiting for the database to be ready..."
+until [ "$(docker inspect -f '{{.State.Health.Status}}' "$DB_CONTAINER_ID")" == "healthy" ]; do
+    sleep 1
+done
+
 # Nuke and migrate db
 (cd server && uv run ./nuke.sh)

.editorconfig

@@ -0,0 +1,57 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# python files
+[*.py]
+trim_trailing_whitespace = true
+
+# config files
+[*.{json,json5,yaml,yml,toml}]
+indent_size = 2
+
+# Javascript and Typescript
+[*.{js,jsx,ts,tsx,vue}]
+indent_size = 2
+block_comment_start = /**
+block_comment = *
+block_comment_end = */
+
+# HTML and CSS
+[*.{htm,html,css,sass,scss,less,svg}]
+indent_size = 2
+
+# Terraform
+[*.{tf,tfvars}]
+indent_size = 2
+
+# Shell scripts
+[*.{sh,bat.tpl,Makefile.tpl}]
+indent_style = tab
+
+# Makefiles
+[Makefile]
+indent_style = tab
+
+# windows scripts
+[*.{cmd,bat}]
+end_of_line = crlf
+
+# Markdown
+[*.md]
+trim_trailing_whitespace = false
+indent_style = space
+indent_size = 2
+
+# diff files
+[*.diff]
+trim_trailing_whitespace = false

.env.prod.example

@@ -8,6 +8,12 @@ APP_NAME=DjangoAPI
 API_SECRET_KEY= CHANGE THIS TO A RANDOM STRING
 API_ALLOWED_HOSTS=".localhost 127.0.0.1 [::1] .codersforcauses.org"
 
+POSTGRES_HOST=db
+POSTGRES_NAME=postgres
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=password
+POSTGRES_PORT=5432
+
 DJANGO_SUPERUSER_PASSWORD= CHANGE THIS TO A RANDOM STRING
 DJANGO_SUPERUSER_EMAIL= CHANGE THIS TO A VALID EMAIL
 DJANGO_SUPERUSER_USERNAME= CHANGE THIS TO A VALID USERNAME

.github/workflows/ci-backend.yml

@@ -9,25 +9,23 @@ on:
 
 jobs:
   lint:
-    name: Run Flake8
+    name: Run linting
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: server
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v5
 
-      - name: "Set up Python"
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.12
+      - name: get ruff
+        uses: astral-sh/ruff-action@v3
 
-      - name: "Install flake8 and plugins"
-        run: |
-          pip install flake8 flake8-django
+      - name: ruff check
+        run: ruff check
 
-      - name: "Run flake8"
-        uses: liskin/gh-problem-matcher-wrap@v1
-        with:
-          linters: flake8
-          run: flake8 --max-line-length 150 server/
+      - name: ruff format check
+        run: ruff format --check
 
   build:
     name: Build and test
@@ -50,18 +48,13 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
+        uses: actions/checkout@v5
 
       - name: Install uv
-        run: pip install uv
+        uses: astral-sh/setup-uv@v6
 
       - name: Install dependencies 👨🏻‍💻
-        run: uv sync --frozen  
+        run: uv sync --frozen --all-groups
 
       - name: Run Migrations 🕊️
         env:

README.md

@@ -158,4 +158,4 @@ You can run `npm install` and `uv sync` in the respective `client` and `server`
 
 ### Changing env vars
 
-Edit the `.env` file in the respective directory (client or server).
+Edit the `.env` file in the respective directory (client or server).

client/eslint.config.mjs

@@ -6,7 +6,7 @@ import tsParser from "@typescript-eslint/parser";
 const compat = new FlatCompat({
   baseDirectory: import.meta.dirname,
 })
- 
+
 const eslintConfig = [
   ...compat.config({
     extends:  ["next/core-web-vitals", "next/typescript"]
@@ -32,5 +32,5 @@ const eslintConfig = [
     ignores: ["node_modules/**", ".next/**", "next-env.d.ts"]
   }
 ]
- 
-export default eslintConfig
+
+export default eslintConfig

client/next.config.mjs

@@ -1,23 +1,22 @@
-// import os from "node:os";
-// import isInsideContainer from "is-inside-container";
+import os from "node:os";
+import isInsideContainer from "is-inside-container";
 
-// const isWindowsDevContainer = () =>
-//   os.release().toLowerCase().includes("microsoft") && isInsideContainer();
+const isWindowsDevContainer = () =>
+  os.release().toLowerCase().includes("microsoft") && isInsideContainer();
 
 /** @type {import('next').NextConfig} */
-
-const config = {
+const nextConfig = {
   reactStrictMode: true,
-  turbopack: {
-    root: import.meta.dirname,
-  }
-  // Turns on file change polling for the Windows Dev Container
-  // Doesn't work currently for turbopack, so file changes will not automatically update the client.
-    // watchOptions: isWindowsDevContainer()
-    // ? {
-    //     pollIntervalMs: 1000
-    //   }
-    // : undefined,
+  // dumb fix for windows docker
+  webpack: isWindowsDevContainer()
+    ? (config) => {
+        config.watchOptions = {
+          poll: 1000,
+          aggregateTimeout: 300,
+        };
+        return config;
+      }
+    : undefined,
 };
 
-export default config;
+export default nextConfig;

docker-compose.prod.yml

@@ -1,4 +1,16 @@
 services:
+  db:
+    image: postgres:16.4
+    restart: unless-stopped
+    volumes:
+      - ./data/db:/var/lib/postgresql/data
+    env_file: ./.env.prod
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 3s
+      timeout: 3s
+      retries: 5
+
   server:
     image: ghcr.io/codersforcauses/django-nextjs-template-use_uv-prod-server:latest
     container_name: transplant_server
@@ -12,6 +24,8 @@ services:
       - ./opt/static_files:/opt/static_files
     environment:
       - DJANGO_SETTINGS_MODULE=api.settings
+    depends_on:
+      - db
 
   client:
     image: ghcr.io/codersforcauses/django-nextjs-template-use_uv-prod-client:latest