diff --git a/README.md b/README.md index 8633547276..34e83c8f8a 100644 --- a/README.md +++ b/README.md @@ -48,14 +48,25 @@ This guide will work for both **starting from scratch** and **migrating from Mis ## 📦 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 [Redis](https://redis.io/) v6 (v7 recommended) +- 📗 (Optional) [FFmpeg](https://ffmpeg.org/) + - 🛰️ (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 ```sh @@ -71,6 +82,14 @@ cd calckey/ 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 - To add custom CSS for all users, edit `./custom/instance.css`.