docs: 📝 improve install instructions
This commit is contained in:
parent
32e33fb21a
commit
686a54746e
1 changed files with 20 additions and 1 deletions
21
README.md
21
README.md
|
@ -48,14 +48,25 @@ This guide will work for both **starting from scratch** and **migrating from Mis
|
||||||
|
|
||||||
## 📦 Dependencies
|
## 📦 Dependencies
|
||||||
|
|
||||||
- At least 🐢 [NodeJS](https://nodejs.org/en/) v18.12.1 (v19.1.0 recommended)
|
- 🐢 At least [NodeJS](https://nodejs.org/en/) v18.12.1 (v19.1.0 recommended)
|
||||||
|
- Best installed with [nvm](https://github.com/nvm-sh/nvm)
|
||||||
|
|
||||||
- 🐘 At least [PostgreSQL](https://www.postgresql.org/) v12
|
- 🐘 At least [PostgreSQL](https://www.postgresql.org/) v12
|
||||||
|
|
||||||
- 🍱 At least [Redis](https://redis.io/) v6 (v7 recommended)
|
- 🍱 At least [Redis](https://redis.io/) v6 (v7 recommended)
|
||||||
|
|
||||||
|
- 📗 (Optional) [FFmpeg](https://ffmpeg.org/)
|
||||||
|
|
||||||
- 🛰️ (Optional, for non-Docker) [pm2](https://pm2.io/)
|
- 🛰️ (Optional, for non-Docker) [pm2](https://pm2.io/)
|
||||||
|
|
||||||
|
### 🏗️ Build dependencies
|
||||||
|
|
||||||
|
- 🦬 C/C++ compiler & build tools
|
||||||
|
- `build-essential` on Debian/Ubuntu Linux
|
||||||
|
- `base-devel` on Arch Linux
|
||||||
|
|
||||||
|
- 🐍 Python 3
|
||||||
|
|
||||||
## 👀 Get folder ready
|
## 👀 Get folder ready
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
@ -71,6 +82,14 @@ cd calckey/
|
||||||
corepack enable
|
corepack enable
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 🐘 Create database
|
||||||
|
|
||||||
|
Assuming you set up PostgreSQL correctly, all you have to run is:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
psql postgres -c "create database calckey with encoding = 'UTF8';"
|
||||||
|
```
|
||||||
|
|
||||||
## 💅 Customize
|
## 💅 Customize
|
||||||
|
|
||||||
- To add custom CSS for all users, edit `./custom/instance.css`.
|
- To add custom CSS for all users, edit `./custom/instance.css`.
|
||||||
|
|
Loading…
Reference in a new issue