Getting Started

Install dependencies:

cd /Users/trbouma/projects/safebox-web
poetry install

Create a local environment file:

cp .env.example .env

If no example file is present, create .env with the values needed for your deployment. At minimum, local development normally needs a cookie key and a default bootstrap relay.

Run the web app:

poetry run uvicorn app.main:app --host 127.0.0.1 --port 8000 --reload

Then open:

http://127.0.0.1:8000

Work against a local Acorn checkout

For sibling development with /Users/trbouma/projects/safebox-acorn, install Acorn into the Safebox Web environment as editable:

poetry run pip install -e /Users/trbouma/projects/safebox-acorn

This makes Acorn code changes visible to Safebox Web without rebuilding a package.

Build this site

poetry install --with docs
poetry run mkdocs serve

The documentation server will print a local URL, usually:

http://127.0.0.1:8000