From 63a97629ecf41b72b84d0e2ce5fc80a8a081f267 Mon Sep 17 00:00:00 2001 From: root Date: Wed, 10 May 2023 16:58:05 -0600 Subject: [PATCH] Login to site --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e327700..1dcb02a 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,14 @@ git clone https://codeberg.org/calckey/calckey cd calckey/ ``` +The default branch is `main`. +If you want to do a different branch, check it out, ala: + +``` +git checkout remotes/origin/develop +``` + + Install calckey NodeJS dependencies: ``` corepack enable @@ -79,7 +87,7 @@ Setup thusly. Database creation (change username at end): ``` -sudo -u postgres createuser --createdb debian +sudo -u postgres createuser --createdb --pwprompt debian psql postgres -c "create database calckey with encoding = 'UTF8';" ``` @@ -102,6 +110,8 @@ sudo systemctl restart nginx # Configure Calckey Configure thusly. +Go back to the Calckey git directory cloned above. + ``` cp .config/example.yml .config/default.yml $EDITOR .config/default.yml @@ -113,6 +123,36 @@ Set, like my example: * `db user: debian` # and other needed db settings +# Build Calckey +Build thusly. + +``` +pnpm install +NODE_ENV=production pnpm run build +``` + +This will set up the database. If it fails here, check Postgres. +``` +pnpm run migrate +``` + + +# Run Calckey +Run thusly. + +``` +NODE_ENV=production pnpm run start +``` + + +# Web +Go to Calckey using the url in `.config/default.yml`. +Example: + +https://rs-calckey.jebba.moe + +The first user you create will be the admin user. + # Copyright Unofficial project, not part of official Calckey software or