Skip to content

Latest commit

 

History

History
154 lines (125 loc) · 4.33 KB

development.md

File metadata and controls

154 lines (125 loc) · 4.33 KB

development

environment

highly recommended to use vscode + devcontainer.

non-rust-or-js dependencies

  • dav1d for the image crate to decode avif images and encode in blurhash.
  • 7zz CLI for interacting with archive files.

automatically handled by the .devcontainer/postinstall.sh script.

architectures

development 
flowchart TD
  caddy["`**caddy server**<br>_apply cert, rewrite headers_`"]
  server["`**rust server**<br>_serve the APIs_`"]
  client["`**nitro server**<br>_serve the nuxt client_`"]
  db["`**postgres database**`"]

  browser <-- <b>https:\/\/</b>localhost:5173 --> caddy

  caddy <-- localhost:3001 --> server
  caddy <-- localhost:3000 --> client
  server <-- postgres:5432 --> db

  subgraph db_container["container"]
    db
  end

  subgraph devcontainer
    server
    client
    db_container
  end

  subgraph host_subgraph["host OS"]
    browser
    caddy
    devcontainer
  end

  style host_subgraph fill:transparent
  style devcontainer fill:transparent
Loading
  • if you're using wsl, run caddy on windows, not inside wsl for it to install the cert into the windows certificate store.
  • the command: caddy run -c Caddyfile
production 
flowchart LR
  server["`**rust server**<br>_serve both the APIs<br>and the nuxt client_`"]
  db["`**postgres<br>database**`"]
  reverse_proxy["`**reverse proxy<br>_Caddy, NGINX, ..._**`"]

  server <-- postgres:5432 --> db
  server <-- Yomuyume:8080 --> reverse_proxy
  reverse_proxy <-- example.com<br>_with TLS_ --> browser
  server <-- server_ip:8080 --> browser

  subgraph client_os["client OS"]
    browser
  end
  subgraph db_container["container"]
    db
  end
  subgraph server_container["container"]
    server
  end
  subgraph rp_container["container"]
    reverse_proxy
  end

  subgraph docker
    server_container
    db_container
    rp_container
  end

  subgraph server_os["server OS"]
    reverse_proxy
    docker
  end

  style server_os fill:transparent
  style docker fill:transparent
  style client_os fill:transparent
Loading
  • freely choose where to put the reverse proxy, I just prefer it to be in a container rather than the host OS of the server.
  • skip the reverse proxy entirely and use your_server_hostname:8080 or your_server_ip:8080 directly if that's your thing.
production w/ Cloudflare tunnel 
  flowchart LR
    server["`**rust server**<br>_serve both the APIs<br>and the nuxt client_`"]
    db["`**postgres<br>database**`"]
    cloudflared["`**cloudflared**`"]

    server <-- postgres:5432 --> db
    server <-- Yomuyume:8080 --> cloudflared
    cloudflared <-- secure tunnel --> cloudflare_cdn["`Cloudflare<br>global CDN`"]
    cloudflare_cdn <-- example.com<br>_with TLS_ --> browser

    subgraph client_os["client OS"]
      browser
    end
    subgraph db_container["container"]
      db
    end
    subgraph server_container["container"]
      server
    end
    subgraph cloudflare_container["container"]
      cloudflared
    end

    subgraph docker
      server_container
      db_container
      cloudflare_container
    end

    subgraph server_os["server OS"]
      cloudflared
      docker
    end

    style server_os fill:transparent
    style docker fill:transparent
    style client_os fill:transparent
Loading
  • one advantage of this is if you use Cloudflare access to protect applications running on your server, Yomuyume (in the future) can read the authentication headers from Cloudflare and access the app directly without re-login.

repo structure

  • .devcontainer/: everything needed for the development environment
  • benches/: some micro benchmarks
  • database/: schemas, migrations .sql files
  • src/: the nuxt spa web client
  • src-rust/: the rust server

interact with the database

using sqlx::query!() to achieve compile-time syntactic and semantic checks, but it can only interact with one database inside a Postgres server at a time (there's only one DATABASE_URL env var).

as a result, we share the same database for the backend itself and the benchmarks, so try to keep everything in database/ neat and tidy. sqltools allows you to Run Selected Query in the context menu, use that.