deepcrayon
/
calckey-cruft
1
0
Fork 0
Code Releases Activity

Login to site

main
root 2023-05-10 16:58:05 -06:00
parent 287a12f6ce
commit 63a97629ec
1 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -63,6 +63,14 @@ git clone https://codeberg.org/calckey/calckey
cd 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: Install calckey NodeJS dependencies:
``` ```
corepack enable corepack enable
@ -79,7 +87,7 @@ Setup thusly.
Database creation (change username at end): 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';" psql postgres -c "create database calckey with encoding = 'UTF8';"
``` ```
@ -102,6 +110,8 @@ sudo systemctl restart nginx
# Configure Calckey # Configure Calckey
Configure thusly. Configure thusly.
Go back to the Calckey git directory cloned above.
``` ```
cp .config/example.yml .config/default.yml cp .config/example.yml .config/default.yml
$EDITOR .config/default.yml $EDITOR .config/default.yml
@ -113,6 +123,36 @@ Set, like my example:
* `db user: debian` # and other needed db settings * `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 # Copyright
Unofficial project, not part of official Calckey software or Unofficial project, not part of official Calckey software or