π 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
Contributing
How to set up the project
Prerequisites
- Install Bun
- Install Golang
- Install MySQL and create a database with name
alexandrie(you can change it in config.toml)
Steps
- Clone the repository.
- Update the .env file in the /backend and /frontend directories with your credentials & configurations.
- Go to /backend and run
go mod downloadto install the dependencies and then start withgo run main.go. - Start minio server with
minio server ./minio --console-address :9001 --address "localhost:9000" - Go to /frontend and run
bun install, and then start withbun dev.
If you are on Linux you can use the following commands to start the application:
make frontend
make minio
make backend
How to contribute
Don't hesitate to contribute to the project. You can open an issue or a pull request :)