**🌎 **[Calckey](https://stop.voring.me/)** is an open source, decentralized social media platform that's free forever! 🚀**

# ✨ About Calckey - Calckey is based off of Misskey, a powerful microblogging server on ActivityPub with features such as emoji reactions, a customizable web ui, rich chatting, and much more! - Calckey adds many quality of life changes and bug fixes for users and instance admins alike. - Read **[this document](./CALCKEY.md)** all for current and future differences. - Notable differences: - Improved UI/UX (especially on mobile) - Improved notifications - Improved instance security - Recommended Instances timeline - OCR image captioning - New and improved Groups - Many more user and admin settings - [So much more!](./CALCKEY.md)

# 🥂 Links - 💸 Liberapay: https://liberapay.com/ThatOneCalculator - 💁 Matrix support room: https://matrix.to/#/#calckey:matrix.fedibird.com - 📜 Instance list: https://calckey.fediverse.observer/list - 📖 JoinFediverse Wiki: https://joinfediverse.wiki/What_is_Calckey%3F # 🌠 Getting started This guide will work for both **starting from scratch** and **migrating from Misskey**. # 🐳 # 🔨 Building from source You need at least 🐢 NodeJS v16.15.0 (v18.20.0 recommended!) and at least 🧶 Yarn v3! > ⚠️ NodeJS v19 is not supported as of right now because of [this issue](https://github.com/nodejs/node-gyp/issues/2757). ## 👀 Get folder ready ```sh git clone https://codeberg.org/thatonecalculator/calckey.git cd calckey/ # git checkout main # if you want only stable versions ``` ## 📩 Install dependencies ```sh # nvm install 18.4.0 && nvm alias default 18.4.0 && nvm use 18.4.0 corepack enable yarn set version berry ``` ## 💅 Customize - To add custom CSS for all users, edit `./custom/instance.css`. - To add static assets (such as images for the splash screen), place them in the `./custom/` directory. They'll then be avaliable on `https://yourinstance.tld/static-assets/filename.ext`. ## 🚚 Migrating from Misskey to Calckey > ⚠️ Because of their changes, migrating from Foundkey is not supported. ```sh cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/` with misskey path, replace `default.yml` with `docker.yml` if you use docker cp -r ../misskey/files . # if you don't use object storage ``` ## 🚀 Build and launch! ### 🐢 NodeJS #### `git pull` and run these steps to update Calckey in the future! ```sh # git pull yarn install NODE_ENV=production yarn run build && yarn run migrate # Edit service to point to calckey folder and restart! ``` ### 🐋 Prebuilt Docker image ```sh docker pull thatonecalculator:calckey docker up -d ``` ### 🐳 Docker Compose ```sh sudo docker compose build sudo docker-compose run --rm web yarn run init sudo docker compose up -d ```