From 481d5e0104c2783adeb187b88b0945bfe8bd75ad Mon Sep 17 00:00:00 2001
From: root <root@localhost>
Date: Wed, 10 May 2023 15:30:52 -0600
Subject: [PATCH] Calckey setup notes

---
 README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15e4bd1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,84 @@
+# 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).
+
+Install from Debian repos:
+
+```
+apt update
+apt install build-essential curl python3 python-is-python3 postgresql \
+            ffmpeg
+
+apt install -t bullseye-backports redis
+
+```
+
+Not using Docker or Elasticsearch.
+
+## 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
+```
+
+Maybe need this PM2 thing:
+
+```
+npm install pm2 -g
+```
+
+
+# Download
+```
+git clone https://codeberg.org/calckey/calckey
+cd calckey/
+```
+
+# Build
+```
+foo
+```
+
+
+# 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 &copy; 2023, Jeff Moe.*
+