danvics/soulsync
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Clean up docs related to local development instructions

Browse source
This commit is contained in:
Antti Kettunen 2026-05-02 17:03:49 +03:00
parent 3df5e4b76d
commit f176ba1eb0
No known key found for this signature in database
GPG key ID: C6B2A3D250359BD7
2 changed files with 7 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -297,7 +297,7 @@ Use two terminals so the backend and Vite stay independent:
```bash
cd webui
npm ci
npm run dev -- --host 127.0.0.1 --port 5173
npm run dev
```
Vite hot reloads the React side when you change webui files.
@ -437,22 +437,9 @@ SoulSync uses a `dev` → `main` flow:
### Running locally
```bash
python -m pip install -r requirements-dev.txt
python -m ruff check . # must be 0 errors
python -m pytest # all tests must pass
```
Use the [Local Development](#local-development) section above for the full repo-wide setup and the portable dev launcher.
For web UI development, keep the backend and Vite dev server in separate terminals:
```bash
gunicorn -c gunicorn.dev.conf.py wsgi:application
cd webui
npm install
npm run dev -- --host 127.0.0.1 --port 5173
```
If you want a convenience wrapper, `./dev.sh` starts both halves together.
For web UI work, see [webui/README.md](webui/README.md). It keeps the React-side notes close to the app while this file stays the single place for repo-wide dev instructions.
Ruff config lives in `pyproject.toml`. The ruleset is intentionally lenient — it catches real bugs (undefined names, import shadowing, closure-in-loop) without style nits.

27
webui/README.md
View file

@ -67,27 +67,8 @@ That order avoids load-time references to missing globals and keeps the React si
## Development
The recommended dev flow keeps the backend and frontend separate:
The repo root now owns the full local-dev instructions. Start there for the
portable launcher and backend/frontend setup:
1. Start the Python backend:
```bash
gunicorn -c gunicorn.dev.conf.py wsgi:application
```
The dev Gunicorn config watches backend files and restarts the Python server when they change.
2. Start the Vite dev server in another terminal:
```bash
cd webui
npm ci
npm run dev -- --host 127.0.0.1 --port 5173
```
Vite hot reloads the React side when you change webui files.
For linting and formatting, use:
```bash
npm run check
npm run fix
```
If you want a convenience launcher, the repo root includes `python dev.py`
for any OS and `./dev.sh` as a Unix shell wrapper.
1. [README.md](../README.md) for the end-to-end dev flow
2. `npm run check` and `npm run fix` for React-side linting and formatting