A greatly enhanced fork of Misskey with better UI/UX, security, features, and more!
Go to file
Kainoa Kanter d56c0f3708 Merge pull request 'develop' (#9031) from develop into main
Reviewed-on: https://codeberg.org/thatonecalculator/calckey/pulls/9031
2022-08-16 00:31:09 +02:00
.config enhance: Redisをioredisに統一してIPv6サポート (#8869) 2022-06-24 19:22:19 +09:00
.github Move title svg location 2022-08-08 15:10:31 -07:00
.okteto ok-to-test with okteto (#8799) 2022-06-09 00:50:23 +09:00
.vscode Update extensions.json 2022-05-14 18:50:16 +09:00
.yarn/plugins/@yarnpkg 🙏 2022-05-31 00:13:41 -07:00
chart chore(dev): use .yaml for prevent okteto error 2022-05-15 22:32:50 +09:00
custom feat: custom css/assets 2022-08-09 13:09:54 -07:00
cypress Obliteration of Ai-chan 🐱🔫 2022-08-08 14:58:27 -07:00
locales Seperate splash screen settings in admin panel 2022-08-09 13:09:54 -07:00
packages Merge remote-tracking branch 'misskey/develop' into develop 2022-08-15 15:21:46 -07:00
scripts wip 2022-06-04 08:01:02 +00:00
.dockerignore Update .dockerignore 2022-05-31 08:33:03 -07:00
.editorconfig Use tabs in json 2017-05-24 20:27:39 +09:00
.gitattributes MisskeyRoom (#5267) 2019-08-18 14:41:33 +09:00
.gitignore Avoid adding custom CSS to git patches :) 2022-08-10 10:18:10 +02:00
.node-version Update .node-version 2022-06-06 21:01:00 +09:00
.vsls.json Add .vsls.json 2018-08-13 00:24:45 +09:00
.yarnrc.yml fix 2022-07-19 12:16:27 -07:00
CALCKEY.md docs: 📝 planning join reasons 2022-08-10 00:04:32 -07:00
CHANGELOG.md Merge remote-tracking branch 'misskey/develop' into develop 2022-08-15 15:21:46 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-17 10:01:05 +09:00
CONTRIBUTING.md b3 2022-07-21 12:48:23 -07:00
COPYING feat: auto nsfw detection (#8840) 2022-07-07 21:06:37 +09:00
Dockerfile Fix bullboard 2022-08-07 23:22:49 -07:00
LICENSE Use AGPLv3 2018-03-28 22:56:28 +09:00
Procfile Create Procfile 2019-04-05 18:17:30 +09:00
README.md docs: 📝 warning for node 18.6.0 2022-08-10 00:50:50 -07:00
SECURITY.md Create SECURITY.md 2021-05-24 05:50:45 +09:00
cypress.config.ts update cypress 2022-06-11 15:53:45 +09:00
docker-compose.yml feat(dev): okteto integration 2022-05-15 16:39:23 +09:00
gulpfile.js feat: custom css/assets 2022-08-09 13:09:54 -07:00
package.json feat: 🔖 .1 2022-08-15 15:25:58 -07:00
yarn.lock yarn lock 2022-08-15 15:25:15 -07:00

README.md

Calckey logo

🌎 Calckey 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 all for current and future differences.
  • Notable differences:
    • Improved UI/UX, notifications, security, and more
    • Recommended Instances timeline
    • Many more user and admin settings

🥂 Links

📝 Documentation

  • Misskey documentation can be found on Misskey Hub
    • To make a new Calckey instance, read their documentation for building from source or using Docker, but replace their repo link (https://github.com/misskey-dev/misskey.git) with https://codeberg.org/thatonecalculator/calckey.git.
  • API reference can be found on any Calckey instance's API doc page

🚚 Migrating from Misskey to Calckey

You need at least 🐢 NodeJS v16.15.0 (v18.4.0 recommended!) and exactly 🧶 Yarn v3.2.2!

⚠️ Please don't use NodeJS v18.6.0, as it's known to cause problems.

📩 Install dependencies

# nvm install 18.4.0 && nvm alias default 18.4.0 && nvm use 18.4.0
corepack enable
yarn set version berry

👀 Get folder ready

git clone https://codeberg.org/thatonecalculator/calckey.git
cd calckey/
# git checkout main # if you want only stable versions
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

💅 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.

🚀 Build and launch!

git pull and run these steps to update Calckey in the future!

# git pull
yarn install # prepend `YARN_CHECKSUM_BEHAVIOR=update` if it doesn't work
NODE_ENV=production yarn run build && yarn run migrate
# Edit service to point to calckey folder and restart!

🐳 Docker

# git pull
sudo docker-compose build
sudo docker-compose stop && sudo docker-compose up -d