π The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.
Vue dockergolangkanbanknowledge-baseknowledge-managementmarkdownnote-takingnotesnotes-appnotionnuxtnuxtjsoffline-firstoidcpwaselfhostedssovuevuejswiki
Update contributing guide
Smaug67398691073c0639
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex ce41190d..80464030 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -8,18 +8,13 @@- [Golang](https://go.dev/)- [MySQL](https://www.mysql.com/)-### Clone the database--The SQL model is in the `database` folder. You can import it to your MySQL database.--It's not necessary to fill the `City_IPv4_complete`, `City_IPv6_complete`, `City_Locations_fr` tables. They are used for the geolocation feature.-### Steps1. Clone the repository.-2. Go to /backend and run `bun install`, change `.env.example` to `.env` and then start with `bun main.ts`.-3. Go to /cdn and start with `go run main.go`.-4. Go to /frontend and run `bun install`, and then start with `bun dev`.+1. Update the .env file in the /backend and /frontend directories with your credentials & configurations.+1. Go to /backend and run `go mod download` to install the dependencies and then start with `go run main.go`.+1. Start minio server with `minio server ./minio --console-address :9001 --address "localhost:9000"`+1. Go to /frontend and run `bun install`, and then start with `bun dev`.### How to contribute