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.

1. 1

   Clone the repository

   Needs Git: xcode-select --install. The repo uses git submodules, so the clone fetches them too.

   git clone --recurse-submodules https://github.com/gitroomhq/postiz-app.git
   cd postiz-app

   Copy
2. 2

   Install the required runtimes

   Node.js 20.17.0

   # needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
   nvm install 20

   Copy
3. 3

   Configure environment variables

   Fill in secrets: JWT_SECRET, CLOUDFLARE_ACCESS_KEY, CLOUDFLARE_SECRET_ACCESS_KEY, APPLE_KEY_ID, APPLE_PRIVATE_KEY, X_API_KEY, X_API_SECRET, LINKEDIN_CLIENT_SECRET

   cp .env.example .env.local

   Copy
4. 4

   Start backing services

   Needs: Redis, PostgreSQL, Elasticsearch / OpenSearch

   brew install --cask docker  # Docker Desktop
   docker compose -f docker-compose.yaml up -d

   Copy

   If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
5. 5

   Install dependencies

   corepack enable
   pnpm install

   Copy
6. 6

   Set up the database / app

   pnpm prisma migrate dev

   Copy
7. 7

   Run it

   pnpm dev

   Copy
8. 8

   Run the tests

   pnpm test

   Copy