initial commit after split
This commit is contained in:
23
README.md
23
README.md
@@ -1,2 +1,25 @@
|
||||
# govoplan-files
|
||||
|
||||
GovOPlaN Files module.
|
||||
|
||||
This repository owns the Files module backend manifest, API router, schemas, storage service layer, SQLAlchemy model definitions, migration registration path, and Files WebUI source bundle. Runtime access to auth/session/settings and cross-module models is provided by govoplan-core and the installed module packages.
|
||||
|
||||
The WebUI bundle is exposed as the local npm package `@govoplan/files-webui` from `webui/`. It depends on `@govoplan/core-webui` for shared API/CSRF/auth helpers, core types, generic UI components and shell primitives.
|
||||
|
||||
## Development
|
||||
|
||||
Install the backend module through the core development environment:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -r requirements-dev.txt
|
||||
```
|
||||
|
||||
Install the WebUI host dependencies from the core WebUI runner:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core/webui
|
||||
PATH=/home/zemion/.nvm/versions/node/v22.22.3/bin:$PATH /home/zemion/.nvm/versions/node/v22.22.3/bin/npm install
|
||||
```
|
||||
|
||||
The backend module is registered through the `govoplan.modules` entry point `files`.
|
||||
|
||||
Reference in New Issue
Block a user