From bef9852a6f372e2f9b4eed995002edc54d615fa8 Mon Sep 17 00:00:00 2001 From: Leo Vasanko Date: Thu, 14 Aug 2025 10:58:05 -0700 Subject: [PATCH] Fine tuning README --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 6f8815d..fa87336 100644 --- a/README.md +++ b/README.md @@ -50,38 +50,7 @@ cista.example.com { } ``` -Nxing or other proxy may be similarly used, or alternatively you can run `cista -l cista.example.com` with cert and key placed in the cista config dir. - -## Development setup - -For rapid development, we use the Vite development server for the Vue frontend, while running the backend on port 8000 that Vite proxies backend requests to. Each server live reloads whenever its code or configuration are modified. - -Make sure you have git, uv and bun (or npm) installed. - -Backend (Python) – setup and run: - -```fish -git clone https://git.zi.fi/Vasanko/cista-storage.git -cd cista-storage -uv sync --dev -uv run cista --dev -l :8000 /path/to/files -``` - -Frontend (Vue/Vite) – run the dev server in another terminal: - -```fish -cd frontend -bun install -bun run dev -``` - -Building the package for release (frontend + Python wheel/sdist): - -```fish -uv build -``` - -Vue is used to build files in `cista/wwwroot`, included prebuilt in the Python package. `uv build` runs the project build hooks to bundle the frontend and produce a NodeJS-independent Python package. +Nxing or other proxy may be similarly used, or alternatively you can place cert and key in cista config dir and run `cista -l cista.example.com` ## System Deployment @@ -121,3 +90,34 @@ foo.example.com, bar.example.com { reverse_proxy unix//srv/cista/{host}/socket } ``` + +## Development setup + +For rapid development, we use the Vite development server for the Vue frontend, while running the backend on port 8000 that Vite proxies backend requests to. Each server live reloads whenever its code or configuration are modified. + +Make sure you have git, uv and bun (or npm) installed. + +Backend (Python) – setup and run: + +```fish +git clone https://git.zi.fi/Vasanko/cista-storage.git +cd cista-storage +uv sync --dev +uv run cista --dev -l :8000 /path/to/files +``` + +Frontend (Vue/Vite) – run the dev server in another terminal: + +```fish +cd frontend +bun install +bun run dev +``` + +Building the package for release (frontend + Python wheel/sdist): + +```fish +uv build +``` + +Vue is used to build files in `cista/wwwroot`, included prebuilt in the Python package. `uv build` runs the project build hooks to bundle the frontend and produce a NodeJS-independent Python package.