Skip to main content

Installation

Prerequisites​

Before you start, make sure you have:

  • Node.js 20+ — node --version
  • pnpm 10.19.0+ — pnpm --version
  • Docker — for local PostgreSQL, Redis, and NATS
  • Git — for cloning the repository

Clone the Repository​

git clone https://github.com/Arkos-Plataform/platform.git
cd platform

Install Dependencies​

pnpm install

This installs all workspace dependencies across services, apps, and tools.

Start Local Infrastructure​

docker-compose up -d

This starts:

  • PostgreSQL 16 on localhost:5432
  • Redis 7 on localhost:6379
  • NATS JetStream on localhost:4222

Verify Installation​

pnpm validate

If the output shows no errors, your installation is complete.

Install arkgen CLI​

arkgen is the ArkOS code generator. It is already included as a dev dependency, but you can also install it globally:

npm install -g @arkos-plataform/arkgen

Next Steps​