Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
Docs is an open-source text editor: web-native, made for real-time collaboration, cleanly structured documents and sub-documents with full ownership of your data. Built to scale with Django and React.
Fresh setup, read just now
Will it work on macOS?
Heads-upIt also needs PostgreSQL and Redis.
The maintainers included bin/install-hooks.sh. Run it from the cloned folder after reading it.
bash bin/install-hooks.sh
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install. The repo uses git submodules, so the clone fetches them too.
git clone --recurse-submodules https://github.com/suitenumerique/docs.git cd docs
Docker
brew install --cask docker # Docker Desktop
Needs: PostgreSQL, Redis
brew install --cask docker # Docker Desktop docker compose -f compose.yml up -d
Docker Desktop must be open and running.
docker build -t docs . docker run --rm -it docs
No reports for macOS yet.
GitManual AI Agent reads the 14 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.