calckey/README.md

70 lines
2.3 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-07-18 23:50:49 +00:00
<img src="./assets/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
2021-11-21 09:40:09 +00:00
## ✨ Features
- **ActivityPub support**\
2022-07-18 23:50:49 +00:00
Not on Calckey? No problem! Not only can Calckey/Misskey instances talk to each other, but you can make friends with people on other networks like Mastodon and Pixelfed!
2021-11-21 09:40:09 +00:00
- **Reactions**\
You can add emoji reactions to any post! No longer are you bound by a like button, show everyone exactly how you feel with the tap of a button.
2021-11-21 09:40:09 +00:00
- **Drive**\
2022-07-18 23:50:49 +00:00
With Calckey's built in drive, you get cloud storage right in your social media, where you can upload any files, make folders, and find media from posts you've made!
2021-11-21 09:40:09 +00:00
- **Rich Web UI**\
2022-07-18 23:50:49 +00:00
Calckey has a rich and easy to use Web UI!
It is highly customizable, from changing the layout and adding widgets to making custom themes.
Furthermore, plugins can be created using AiScript, an original programming language.
- And much more...
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-07-19 00:39:19 +00:00
## 📝 Documentation
2022-07-19 00:39:19 +00:00
Misskey documentation can be found at [Misskey Hub](https://misskey-hub.net/).
2022-07-19 00:39:19 +00:00
## 🤔 What's different about Calckey?
2022-07-19 00:36:59 +00:00
Read [this](./CALCKEY.md) for current and future differences.
2022-07-19 00:36:11 +00:00
2022-07-19 00:39:36 +00:00
## 🛻 Migrating from Misskey to Calckey
2022-07-19 05:07:59 +00:00
2022-07-27 18:31:56 +00:00
You need at least 🐢 NodeJS v16.15.0 (v18.4.0 reccomended!) and *exactly* 🧶 Yarn v3.2.1!
2022-07-28 02:36:04 +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-07-28 02:36:04 +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-07-19 00:36:11 +00:00
cp ../misskey/.config/default.yml ./.config/default.yml # or wherever misskey folder is
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
```
2022-07-28 02:36:04 +00:00
### 🚀 Build and launch!
2022-07-27 18:31:56 +00:00
#### `git pull` and run these steps to update Calckey in the future!
```sh
# git pull
2022-07-20 02:54:49 +00:00
YARN_CHECKSUM_BEHAVIOR=update yarn install
2022-07-19 00:36:11 +00:00
NODE_ENV=production npm run build && npm 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
```