Reading the repo

Opening the box…

How to set up postiz-app (gitroomhq/postiz-app) · gitmanual

Assembly instructions

gitroomhq/postiz-app

📨 The ultimate agentic social media scheduling tool 🤖

Node.jsNext.jsNestJS#nextjs#open-source#open-source-social-media-scheduling-tool#oss

Difficulty: Involved
Time: 30 min or more
Stars: ★ 40,916
Activity: Updated this month
License: AGPL-3.0
Open issues: 213
Got it running: Be the first
Looked up: 3 h ago

Saved setup from 3 h ago

Start here

Website ↗postiz.comThe project's own site.In the browser ↗Open in GitHub CodespacesThe repo ships a dev container, so nothing to install.

Will it work on my device?

Yes, it runs on macOS

You'll build it yourself with Node.js.
It also needs Redis, PostgreSQL, Elasticsearch / OpenSearch running (Docker handles this).

Checking for

8 steps on macOS

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
```

Install the required runtimes

Node.js 20.17.0

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

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
```
4
Start backing services
Needs: Redis, PostgreSQL, Elasticsearch / OpenSearch
```
brew install --cask docker  # Docker Desktop
docker compose -f docker-compose.yaml up -d
```
If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
5
Install dependencies
```
corepack enable
pnpm install
```
6
Set up the database / app
```
pnpm prisma migrate dev
```
7
Run it
```
pnpm dev
```
8
Run the tests
```
pnpm test
```

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 14 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js 20.17.0runtime
1×pnpm pnpm@10.6.1package manager
1×Redis service
1×PostgreSQL service
1×Elasticsearch / OpenSearch service

83× settings in .env

DATABASE_URL
REDIS_URL
JWT_SECRETsecret
FRONTEND_URL
NEXT_PUBLIC_BACKEND_URL
BACKEND_INTERNAL_URL
CLOUDFLARE_ACCOUNT_ID
CLOUDFLARE_ACCESS_KEYsecret
CLOUDFLARE_SECRET_ACCESS_KEYsecret
CLOUDFLARE_BUCKETNAME
CLOUDFLARE_BUCKET_URL
CLOUDFLARE_REGION
STORAGE_PROVIDER
APPLE_BUNDLE_ID
APPLE_SERVICE_ID
APPLE_TEAM_ID
APPLE_KEY_IDsecret
APPLE_PRIVATE_KEYsecret
X_URL
X_API_KEYsecret
X_API_SECRETsecret
LINKEDIN_CLIENT_ID
LINKEDIN_CLIENT_SECRETsecret
REDDIT_CLIENT_ID
REDDIT_CLIENT_SECRETsecret
GITHUB_CLIENT_ID
GITHUB_CLIENT_SECRETsecret
APPLE_CLIENT_ID
BEEHIIVE_API_KEYsecret
BEEHIIVE_PUBLICATION_ID
LISTMONK_DOMAIN
LISTMONK_USER
LISTMONK_API_KEYsecret
LISTMONK_LIST_ID
THREADS_APP_ID
THREADS_APP_SECRETsecret
FACEBOOK_APP_ID
FACEBOOK_APP_SECRETsecret
YOUTUBE_CLIENT_ID
YOUTUBE_CLIENT_SECRETsecret
TIKTOK_CLIENT_ID
TIKTOK_CLIENT_SECRETsecret
TIKTOK_BUSINESS_CLIENT_ID
TIKTOK_BUSINESS_CLIENT_SECRETsecret
PINTEREST_CLIENT_ID
PINTEREST_CLIENT_SECRETsecret
DRIBBBLE_CLIENT_ID
DRIBBBLE_CLIENT_SECRETsecret
TUMBLR_CLIENT_ID
TUMBLR_CLIENT_SECRETsecret
DISCORD_CLIENT_ID
DISCORD_CLIENT_SECRETsecret
DISCORD_BOT_TOKEN_IDsecret
SLACK_ID
SLACK_SECRETsecret
SLACK_SIGNING_SECRETsecret
MASTODON_URL
MASTODON_CLIENT_ID
MASTODON_CLIENT_SECRETsecret
EXTENSION_ID

Share this manual

Good to know

Monorepo (workspaces) — install from the repo root.
Dev Container config found — you can open it in VS Code Dev Containers or GitHub Codespaces for a zero-setup environment.
Has CLAUDE.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: apps/backend/package.json, apps/commands/package.json, apps/extension/package.json, apps/frontend/package.json and 2 more

package.json scripts (27)

devpnpm run --filter ./apps/extension --filter ./apps/orchestrator --filter ./apps/backend --filter ./apps/frontend --parallel dev
dev-backendpnpm run --filter ./apps/backend --filter ./apps/frontend --parallel dev
pm2pnpm run pm2-run
publish-sdkpnpm run --filter ./apps/sdk publish
pm2-runpm2 delete all || true && pnpm run prisma-db-push && pnpm run --parallel pm2 && pm2 logs
dev:stripepnpm dlx concurrently "stripe listen --forward-to localhost:3000/stripe" "pnpm run dev"
buildpnpm -r --workspace-concurrency=1 --filter ./apps/frontend --filter ./apps/backend --filter ./apps/orchestrator run build
build:backendrm -rf apps/backend/dist && pnpm --filter ./apps/backend run build
build:frontendrm -rf apps/frontend/dist && pnpm --filter ./apps/frontend run build
build:orchestratorrm -rf apps/orchestrator/dist && pnpm --filter ./apps/orchestrator run build
build:extensionrm -rf apps/extension/dist && pnpm --filter ./apps/extension run build
dev:backendrm -rf apps/backend/dist && pnpm --filter ./apps/backend run dev
dev:frontendrm -rf apps/frontend/dist && pnpm --filter ./apps/frontend run dev
dev:orchestratorrm -rf apps/orchestrator/dist && pnpm --filter ./apps/orchestrator run dev
start:prod:orchestratorpnpm --filter ./apps/orchestrator run start
start:prod:backendpnpm --filter ./apps/backend run start
start:prod:frontendpnpm --filter ./apps/frontend run start
dev:dockerdocker compose -f ./docker-compose.dev.yaml up -d
commands:build:developmentpnpm --filter ./apps/commands run build
prisma-generatepnpm dlx prisma@6.5.0 generate --schema ./libraries/nestjs-libraries/src/database/prisma/schema.prisma
prisma-db-pushpnpm dlx prisma@6.5.0 db push --schema ./libraries/nestjs-libraries/src/database/prisma/schema.prisma
prisma-db-pullpnpm dlx prisma@6.5.0 db pull --schema ./libraries/nestjs-libraries/src/database/prisma/schema.prisma
prisma-resetcd ./libraries/nestjs-libraries/src/database/prisma && pnpm dlx prisma@6.5.0 db push --force-reset && pnpx prisma@6.5.0 db push
docker-build./var/docker/docker-build.sh
docker-create./var/docker/docker-create.sh

Files we read (14)

.devcontainer/devcontainer.json

.env.example

.github/workflows/build-containers.yml

.github/workflows/build-extension.yaml

.github/workflows/build.yml

.github/workflows/codeql.yml

.github/workflows/deploy-aws.yml

.github/workflows/issue-label-triggers.yml

.gitmodules

CONTRIBUTING.md

README.md

docker-compose.yaml

package.json

pnpm-workspace.yaml

Branch main · 1,037 files in the repo

Opening the box…

Start here

Yes, it runs on macOS

8 steps on macOS

Clone the repository

Install the required runtimes

Configure environment variables

Start backing services

Install dependencies

Set up the database / app

Run it

Run the tests

Did you get it running?

Still stuck? Get a written guide