Parallel Documentation

Appearance

Getting Started ​

Onboarding ​

Prerequisites ​

  • Node.js 22.x (use nvm to install node) nvm install 22.14.0
  • PNPM 10.1.0 (use corepack to install pnpm) Useful commands: corepack use pnpm@latest
  • Docker and Docker Compose (for running services)
bash
brew install ghostscript
brew install graphicsmagick
brew install aws-sso-util
brew install nx
brew install docker
brew install docker-compose

Installation ​

  1. Clone the repository:

    bash
    git clone <repository-url>
cd alphacode

  2. Install dependencies:

    bash
    pnpm install

  3. Login to Nx Cloud (brew install nx if you don't have nx installed):

    bash
    nx login

  4. Create environment files:

    • Create a .env.dev file in the services/coding directories based on services/coding/.env-example
    • Create a .env.dev file in the services/ocr directories based on services/ocr/.env-example
    • Create a .env.dev file in the services/valuation directories based on services/valuation/.env-example
    • Create a .env.dev file in the services/screenflow directories based on services/screenflow/.env-example
    • Create a .env file in the frontend/ directory You will find the .env files for each service in the 1Password application.

  5. Configure local development domain:

    For local development, browsers reject cookies from IP addresses or .localhost domains. Configure a named domain alias instead.

    Add the following entries to your /etc/hosts file:

    127.0.0.1   local.beparallel.com
::1         local.beparallel.com

    Note: The apiDomain in SuperTokens configuration must point to an exact API domain (e.g., coding.app.beparallel.com), while cookieDomain can use a leading dot for subdomain sharing (e.g., .beparallel.com). See SuperTokens multiple API endpoints documentation for details

Project Structure ​

alphacode/
├── services/           # Backend microservices
│   ├── coding/        # Coding service
│   ├── dashboard/        # Dashboard service
│   ├── screenflow/    # Screenflow service
│   ├── valuation/     # Valuation service
│   └── ocr/           # OCR service
├── packages/          # Shared packages
│   ├── nest/          # Shared NestJS utilities
│   ├── models/        # Shared domain models
│   └── utils/         # Shared utilities
├── frontend/          # React frontend application
└── docs/              # Documentation (you are here!)

Next Steps ​