bellingcat/auto-archiver
1
0
Fork 0
mirror of https://github.com/bellingcat/auto-archiver.git synced 2026-06-10 12:18:30 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
cc14e5cb9fa4e66a7d08e4b5fce99d67127a12eb
auto-archiver/docs/source/development/settings_page.md
Patrick Robertson 2ec44f4170 Documentation on building the settings page
2025-02-27 15:42:37 +00:00

939 B
Raw Blame History

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.

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
  1. Generate the schema.json file for the currently installed modules using python scripts/generate_settings_schema.py
  2. Go to the settings folder cd scripts/settings/ and build your environment with npm i
  3. Run a development version of the page with npm run dev
  4. Build a release version of the page with npm run build

A release version creates a single-file app called dist/index.html