calckey-cruft/README.md

# Calckey
Calckey is Fediverse "social media" software similar to Mastodon.

Below are some notes about a test installation setup.

https://calckey.org/

https://codeberg.org/calckey/calckey


# Dependencies

## Debian
Tested on Debian 11 (Stable/Bullseye).

Not using Docker or Elasticsearch.

Install some dependencies from Debian repos:

```
apt update
apt install build-essential curl python3 python-is-python3 postgresql \
            ffmpeg

apt install -t bullseye-backports redis
```


## NodeJS
This is dodgy, like "npm install". Calckey recommends using
nvm to manage NodeJS versions. So run:

```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
```

The log out/in or run:

```
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
```

Then install the right version of `npm` with `nvm`:

```
nvm install 19
nvm use 19
```

Confirm correct version is running:

```
node -v
```


# Download and Install
Thusly.

```
git clone https://codeberg.org/calckey/calckey
cd calckey/
```

Install calckey NodeJS dependencies:
```
corepack enable
corepack prepare pnpm@latest --activate
pnpm i
# pnpm i --no-optional # without Tensorflow. Downloads it anyway.
```


# Setup
Setup thusly.

## Postgres
Database creation (change username at end):

```
sudo -u postgres createuser --createdb debian

psql postgres -c "create database calckey with encoding = 'UTF8';"
```


# Copyright
Unofficial project, not part of official Calckey software or
website. Upstream sources under their respective copyrights.

License: CC By SA 4.0 International and/or AGPLv3+ at your discretion.

*Copyright © 2023, Jeff Moe.*