Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (59 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

81 lines (59 loc) · 1.19 KB

Contributing to Agents

Getting Started

Prerequisites

  • Node.js 20+
  • Docker and Docker Compose

Development Setup

  1. Install dependencies:

    npm ci

  2. Install browser automation skills (for the @web-browser coding agent):

    npm install -g @playwright/cli@latest
playwright-cli install --skills

  3. Start development dependencies (MongoDB, Elasticsearch, etc.):

    npm run dev-deps

  4. Start the API server:

    npm run dev-api

  5. Start the UI development server:

    npm run dev-ui

The application will be available at http://localhost:8080 (or the port specified in .env).

Running Tests

npm run test

Code Style

This project uses:

  • ESLint for JavaScript/TypeScript linting
  • Prettier for code formatting (via ESLint)
  • Conventional Commits for commit messages

Run linting:

npm run lint

Run linting with auto-fix:

npm run lint-fix

Building

To build the application for production:

npm run build

Docker

Build the Docker image:

docker build -t agents .

Run the container:

docker run -p 8080:8080 agents