Skip to content

fix & simplify dev setup guide #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MarcelGeo merged 1 commit into from
Sep 29, 2026
Merged

fix & simplify dev setup guide #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ docker-compose.local.yml
*.pem
*.crt

CLAUDE.md
# Local Claude Code skills
.claude/commands/
19 changes: 16 additions & 3 deletions development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,23 @@ $ cd server
# Install dependencies with pipenv
# Note: You can append --three flag in older versions of pipenv (< 3.16.8 2023-02-04)
$ pipenv install --dev
$ pipenv install --categories="telemetry
$ pipenv install --categories telemetry
$ pipenv run pre-commit install
$ pipenv run pre-commit run --all-files
$ export FLASK_APP=application; export COLLECT_STATISTICS=0
# pipenv loads server/.env automatically; secrets and salts have no defaults
$ cat > .env <<EOF
FLASK_APP=application
COLLECT_STATISTICS=0
SECRET_KEY=$(python3 -c 'import secrets;print(secrets.token_hex(32))')
SECURITY_PASSWORD_SALT=$(python3 -c 'import secrets;print(secrets.token_hex(16))')
SECURITY_EMAIL_SALT=$(python3 -c 'import secrets;print(secrets.token_hex(16))')
SECURITY_BEARER_SALT=$(python3 -c 'import secrets;print(secrets.token_hex(16))')
SECURITY_UNLOCK_SALT=$(python3 -c 'import secrets;print(secrets.token_hex(16))')
MAIL_DEFAULT_SENDER=dev@localhost
MERGIN_BASE_URL=http://localhost:8080
EOF
# folder for project files (LOCAL_PROJECTS default)
$ mkdir -p ../projects
$ pipenv run flask init-db
# create admin user
$ pipenv run flask user create admin topsecret --is-admin --email admin@example.com
Expand All @@ -36,7 +49,7 @@ $ pipenv run flask run # run dev server on port 5000

### Web applications

Before installing the web applications, make sure you have Node.js installed in a supported version. The applications require Node.js version **18 or higher**.
Before installing the web applications, make sure you have Node.js installed in a supported version. The applications require Node.js version **22 or higher**.

```shell
$ cd web-app
Expand Down
Loading