Reading the repo

Opening the box…

How to set up comprai (josehelioaraujo/comprai) · gitmanual

Assembly instructions

josehelioaraujo/comprai

Agente de IA para compras baseado no Universal Commerce Protocol (UCP) — integrações plugáveis com e-commerces, interface conversacional e suporte multi-canal

Node.js.NET

Difficulty: Involved
Time: 30 min or more
Stars: ★ 1
Activity: Updated this month
License: MIT
Open issues: 0
Got it running: Be the first
Looked up: 11 h ago

Saved setup from 11 h ago

Start here

Setup script in the repo

The maintainers included scripts/setup-web-vps.sh. Run it from the cloned folder after reading it.

bash scripts/setup-web-vps.sh

Will it work on my device?

Yes, it runs on macOS

You'll build it yourself with Node.js, .NET SDK.
It also needs PostgreSQL, Redis, Kafka, RabbitMQ running (Docker handles this).

Checking for

6 steps on macOS

Download setup.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.

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/josehelioaraujo/comprai.git
cd comprai
```

Install the required runtimes

Node.js LTS (no version pinned), .NET SDK

# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
nvm install --lts
brew install --cask dotnet-sdk

3
Configure environment variables
Fill in secrets: NEXTAUTH_SECRET, POSTGRES_PASSWORD, DD_API_KEY, NEW_RELIC_LICENSE_KEY, NEW_RELIC_USER_KEY, ML_CLIENT_SECRET, SHOPIFY_ACCESS_TOKEN, RESEND_API_KEY
```
cp .env.example .env
```
4
Start backing services
Needs: PostgreSQL, Redis, Kafka, RabbitMQ
```
brew install --cask docker  # Docker Desktop
docker compose -f docker-compose.yml up -d
```
If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.

Install dependencies

npm ci
dotnet restore comprai.sln
dotnet build comprai.sln

6
Run the tests
```
dotnet test comprai.sln
```

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

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

Parts list

1×Node.js LTS (no version pinned)runtime
1×.NET SDK runtime
1×npm package manager
1×PostgreSQL service
1×Redis service
1×Kafka service
1×RabbitMQ service

33× settings in .env

NEXT_PUBLIC_API_URL
NEXTAUTH_URL
NEXTAUTH_SECRETsecret
GOOGLE_CLIENT_IDoptional
GOOGLE_CLIENT_SECRETsecretoptional
AUTH_TRUST_HOST
POSTGRES_PASSWORDsecret
ConnectionStrings__Redis
USAR_REDIS
USAR_KAFKA
USAR_RABBITMQ
Features__UsarMockDados
Features__UsarRedis
Features__UsarKafka
Features__UsarRabbitMQ
Features__UsarPostgres
OTEL_ENDPOINT
DD_API_KEYsecret
NEW_RELIC_LICENSE_KEYsecret
NEW_RELIC_USER_KEYsecret
NEW_RELIC_ACCOUNT_ID
ML_CLIENT_ID
ML_CLIENT_SECRETsecret
SHOPIFY_ACCESS_TOKENsecret
SHOPIFY_STORE_URL
RESEND_API_KEYsecret
Resend__FromEmail
ADMIN_RESTART_PASSWORDsecret
PII_ENCRYPTION_KEYsecret
CORS_ALLOWED_ORIGINS
GH_PAT
AUTH_SECRETsecret
BUILD_VERSION

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/josehelioaraujo/comprai/badge.svg)](https://gitmanual.com/josehelioaraujo/comprai)

Good to know

A .NET solution with several projects: start the app project with dotnet run --project <path/to/App.csproj> (the README usually names it).
Has AGENTS.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: frontend/admin/package.json, frontend/mobile-v2/package.json, frontend/mobile/package.json, frontend/web/package.json and 11 more

Files we read (13)

.env.example

.github/workflows/admin-restart.yml

.github/workflows/ci-cd.yml

.github/workflows/integration-tests.yml

.github/workflows/mutation-tests.yml

.github/workflows/pentest.yml

.github/workflows/stress-tests.yml

.gitmodules

README.md

docker-compose.yml

frontend/mobile-v2/.env.example

frontend/web/.env.example

package.json

Branch main · 532 files in the repo

Opening the box…

Start here

Yes, it runs on macOS

6 steps on macOS

Clone the repository

Install the required runtimes

Configure environment variables

Start backing services

Install dependencies

Run the tests

Did you get it running?

Still stuck? Get a written guide