Devdocs

The unified documentation experience for developers hacking on Fyra Labs projects.

🛠️ Dependencies

Please make sure you have pnpm first before building.

Hacking

Dev Containers

1. Install the Dev Containers extension in your IDE

   • Zed comes with Dev Containers, see this documentation

   • VSCode users need to install the Dev Containers extension

   • Podman users need to install podman-docker from their package manager

2. Open your IDE and select the "Reopen in Dev Container" option

3. Run pnpm i to install deps

4. Run pnpm run dev or pnpm run dev --host to start the dev server

Flox

1. Get Flox
2. Clone and enter this repo
3. Run flox activate

You can run the dev server with flox services start dev, or to expose to LAN or Tailnet, run flox services start dev-host

On the Host

1. Install pnpm and nodejs
2. Run pnpm i to install deps
3. Run pnpm run dev or pnpm run dev --host to start the dev server

🏗️ Building

Simply clone this repo, then:

pnpm install
pnpm run build # or `pnpm run dev` to run a development server