bellingcat/auto-archiver
1
0
Fork 0
mirror of https://github.com/bellingcat/auto-archiver.git synced 2026-06-12 13:18:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation on building the settings page

Browse Source
This commit is contained in:
Patrick Robertson
2025-02-27 15:42:37 +00:00
parent 1e92c03b1d
commit 2ec44f4170
6 changed files with 52 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/source/development/settings_page.md Normal file
View File

@@ -0,0 +1,20 @@
# Settings Page
The settings page (viewable here TODO: add link), is an easy-to-use UI for users to edit their auto-archiver settings.
The single-file app is built using React and vite. To get started developing the package, follow these steps:
1. Make sure you have Node v22 installed.
```{note} Tip: if you don't have node installed:
Use `nvm` to manage your node installations. Use:
`curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash` to install `nvm` and then `nvm i 22` to install Node v22
```
2. Generate the `schema.json` file for the currently installed modules using `python scripts/generate_settings_schema.py`
3. Go to the settings folder `cd scripts/settings/` and build your environment with `npm i`
4. Run a development version of the page with `npm run dev`
5. Build a release version of the page with `npm run build`
A release version creates a single-file app called `dist/index.html`