Development Workflow & Available Scripts

The Aruuri monorepo utilizes a comprehensive set of scripts to manage development, building, testing, and deployment processes. Powered by Turborepo↗ and pnpm↗, these scripts streamline workflows and ensure consistency across the platform's various applications and packages.

For initial setup and getting your local environment running, please refer to the [Getting Started with Aruuri Development] wiki page. For details on how Aruuri handles deployments and isolated preview environments, see [Deployment & Ephemeral Preview Environments].

Monorepo Structure & Key Principles

Aruuri follows a domain-driven design with functional programming patterns, organized as follows:

• apps/: Independent deployments (e.g., web Next.js app, future cms, functions).
• packages/: Shared code consumed by multiple apps (e.g., services, domain, database, design-tokens, utils).

This structure allows for modular development and shared tooling, managed efficiently by Turborepo.

Available Scripts

Below is a categorized list of essential scripts for working with the Aruuri monorepo.

Development Scripts

These scripts are primarily used during local development to run applications, maintain code quality, and perform initial builds.

Deployment Scripts

These scripts are used to deploy the Aruuri platform to various environments, including production and preview stages. For a detailed understanding of the deployment architecture, please refer to [Deployment & Ephemeral Preview Environments].

SST Preview & State Management

SST provides powerful commands for previewing infrastructure changes and managing the state of deployed resources.

SST Development Scripts

These scripts interact directly with the SST framework for more granular control over the development and debugging of infrastructure.

Package-Specific Scripts

To run commands specific to a single package within the monorepo, use the --filter flag with pnpm.

Build Scripts

Specific build commands for managing package dependencies and assets.

Testing Overview

Aruuri employs a robust testing strategy to ensure code quality and reliability, leveraging the following tools:

• Vitest: A fast, Vite-native unit and integration test framework.
• React Testing Library: For testing React components in a way that encourages good accessibility practices.
• Playwright: For comprehensive end-to-end (E2E) browser testing.

Running Tests

All test suites across the monorepo can be executed with a single command:

This command uses Turborepo to run tests in parallel across all packages.

To run tests for a specific package or to use package-specific test commands (like test:ui or test:coverage), use the --filter flag:

For end-to-end tests:

Test Architecture

• Test files: Can be co-located with source code (.test.ts, .spec.ts, .test.tsx, .spec.tsx) or placed in a dedicated test/ directory within a package.
• Test utilities: Custom render functions with providers (e.g., apps/web/test/utils.tsx) centralize common setup for React component tests.
• Coverage: The V8 provider generates detailed HTML reports, allowing developers to assess test coverage effectively.
• Linting: ESLint rules are configured to prevent accidental imports of test utilities into production code, ensuring a clean separation.

For more detailed information on testing setup, patterns, and best practices, refer to the docs/TESTING.md guide.