calckey/README.md

82 lines
2.6 KiB
Markdown
Raw Normal View History

2021-02-07 02:43:55 +00:00
<div align="center">
2022-07-19 00:39:19 +00:00
<a href="https://stop.voring.me/">
2022-08-08 22:10:31 +00:00
<img src="./.github/title_float.svg" alt="Calckey logo" style="border-radius:50%" width="400"/>
</a>
2022-07-19 05:07:59 +00:00
2022-07-19 00:39:19 +00:00
**🌎 **[Calckey](https://stop.voring.me/)** is an open source, decentralized social media platform that's free forever! 🚀**
2022-07-19 05:07:59 +00:00
2021-02-07 02:43:55 +00:00
</div>
2021-11-20 09:21:18 +00:00
<div>
2021-03-24 02:57:12 +00:00
2022-07-18 23:51:31 +00:00
<img src="https://pool.jortage.com/voringme/misskey/e7cd2a17-8b23-4e1e-b5cf-709480c623e2.png" align="right" height="320px"/>
2018-09-12 20:35:11 +00:00
2022-08-08 06:07:22 +00:00
# ✨ 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:
- Recommended Instances timeline
- Improved notifications
- Many more user and admin settings
2019-02-05 15:13:31 +00:00
2021-11-20 09:21:18 +00:00
</div>
2017-01-23 09:25:52 +00:00
2021-11-20 09:21:18 +00:00
<div style="clear: both;"></div>
2018-04-15 20:04:56 +00:00
2022-08-08 06:07:22 +00:00
# 📝 Documentation
2022-07-28 02:36:58 +00:00
2022-08-08 22:12:21 +00:00
- Misskey documentation can be found on [Misskey Hub](https://misskey-hub.net/)
- API reference can be found on any Calckey instance's [API doc page](https://stop.voring.me/api-doc)
2022-08-08 06:07:22 +00:00
# 🚚 Migrating from Misskey to Calckey
2022-07-19 05:07:59 +00:00
2022-08-08 06:17:48 +00:00
You need at least 🐢 NodeJS v16.15.0 (v18.4.0 recommended!) and *exactly* 🧶 Yarn v3.2.2!
2022-07-27 18:31:56 +00:00
2022-08-08 06:07:22 +00:00
## 📩 Install dependencies
2022-07-19 05:07:59 +00:00
2022-07-19 00:36:11 +00:00
```sh
2022-07-24 15:19:41 +00:00
# nvm install 18.4.0 && nvm alias default 18.4.0 && nvm use 18.4.0
2022-07-19 05:07:59 +00:00
corepack enable
2022-07-19 18:59:20 +00:00
yarn set version berry
```
2022-08-08 06:07:22 +00:00
## 👀 Get folder ready
2022-07-27 18:31:56 +00:00
2022-07-19 18:59:20 +00:00
```sh
2022-07-19 00:36:11 +00:00
git clone https://codeberg.org/thatonecalculator/calckey.git
cd calckey/
2022-07-24 06:15:09 +00:00
# git checkout main # if you want only stable versions
2022-08-08 06:20:57 +00:00
cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/` with misskey path, replace `default.yml` with `docker.yml` if you use docker
2022-07-24 06:15:09 +00:00
# cp -r ../misskey/files . # if you don't use object storage
2022-07-27 18:31:56 +00:00
```
## 💅 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/` folder. They'll then be avaliable on `https://yourinstance.tld/static-assets/filename.png`.
2022-08-08 06:07:22 +00:00
## 🚀 Build and launch!
2022-07-27 18:31:56 +00:00
2022-08-08 06:07:22 +00:00
### `git pull` and run these steps to update Calckey in the future!
2022-07-27 18:31:56 +00:00
```sh
# git pull
2022-08-08 06:19:16 +00:00
yarn install
2022-08-10 03:06:49 +00:00
NODE_ENV=production yarn run build && yarn run migrate
2022-07-19 16:37:56 +00:00
# Edit service to point to calckey folder and restart!
2022-07-19 05:07:59 +00:00
```
2022-07-29 01:25:02 +00:00
2022-08-08 06:07:22 +00:00
### 🐳 Docker
```sh
# git pull
sudo docker-compose build
sudo docker-compose stop && sudo docker-compose up -d
```
2022-07-29 01:25:02 +00:00
# 💸 Patrons
None yet! You can support of the development of this fork here, every little bit counts: https://liberapay.com/ThatOneCalculator/