AutoGPT/autogpt_platform/frontend/README.md

This is the frontend for AutoGPT's next generation

🧢 Getting Started

This project uses pnpm as the package manager via corepack. Corepack is a Node.js tool that automatically manages package managers without requiring global installations.

For architecture, conventions, data fetching, feature flags, design system usage, state management, and PR process, see CONTRIBUTING.md. For Playwright and Storybook testing setup, see TESTING.md.

Prerequisites

Make sure you have Node.js 16.10+ installed. Corepack is included with Node.js by default.

Setup

1. Enable corepack (run this once on your system):

corepack enable

This enables corepack to automatically manage pnpm based on the packageManager field in package.json.

2. Install dependencies:

pnpm i

3. Start the development server:

Running the Front-end & Back-end separately

We recommend this approach if you are doing active development on the project. First spin up the Back-end:

# on `autogpt_platform`
docker compose --profile local up deps_backend -d
# on `autogpt_platform/backend`
poetry run app

Then start the Front-end:

# on `autogpt_platform/frontend`
pnpm dev

Open http://localhost:3000 with your browser to see the result. If the server starts on http://localhost:3001 it means the Front-end is already running via Docker. You have to kill the container then or do docker compose down.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Running both the Front-end and Back-end via Docker

If you run:

# on `autogpt_platform`
docker compose up -d

It will spin up the Back-end and Front-end via Docker. The Front-end will start on port 3000. This might not be what you want when actively contributing to the Front-end as you won't have direct/easy access to the Next.js dev server.

Subsequent Runs

For subsequent development sessions, you only need to run:

pnpm dev

Every time a new Front-end dependency is added by you or others, you will need to run pnpm i to install the new dependencies.

Available Scripts

• pnpm dev - Start development server
• pnpm build - Build for production
• pnpm start - Start production server
• pnpm lint - Run ESLint and Prettier checks
• pnpm format - Format code with Prettier
• pnpm types - Run TypeScript type checking
• pnpm test - Run Playwright tests
• pnpm test-ui - Run Playwright tests with UI
• pnpm fetch:openapi - Fetch OpenAPI spec from backend
• pnpm generate:api-client - Generate API client from OpenAPI spec
• pnpm generate:api - Fetch OpenAPI spec and generate API client

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

🔄 Data Fetching

See CONTRIBUTING.md for guidance on generated API hooks, SSR + hydration patterns, and usage examples. You generally do not need to run OpenAPI commands unless adding/modifying backend endpoints.

🚩 Feature Flags

See CONTRIBUTING.md for feature flag usage patterns, local development with mocks, and how to add new flags.

🚚 Deploy

TODO

📙 Storybook

Storybook is a powerful development environment for UI components. It allows you to build UI components in isolation, making it easier to develop, test, and document your components independently from your main application.

Purpose in the Development Process

1. Component Development: Develop and test UI components in isolation.
2. Visual Testing: Easily spot visual regressions.
3. Documentation: Automatically document components and their props.
4. Collaboration: Share components with your team or stakeholders for feedback.

How to Use Storybook

1. Start Storybook: Run the following command to start the Storybook development server:

   pnpm storybook
   

   This will start Storybook on port 6006. Open http://localhost:6006 in your browser to view your component library.

2. Build Storybook: To build a static version of Storybook for deployment, use:

   pnpm build-storybook
   

3. Running Storybook Tests: Storybook tests can be run using:

   pnpm test-storybook
   

4. Writing Stories: Create .stories.tsx files alongside your components to define different states and variations of your components.

By integrating Storybook into our development workflow, we can streamline UI development, improve component reusability, and maintain a consistent design system across the project.

🔭 Tech Stack

Core Framework & Language

• Next.js - React framework with App Router
• React - UI library for building user interfaces
• TypeScript - Typed JavaScript for better developer experience

Styling & UI Components

• Tailwind CSS - Utility-first CSS framework
• shadcn/ui - Re-usable components built with Radix UI and Tailwind CSS
• Radix UI - Headless UI components for accessibility
• Phosphor Icons - Icon set used across the app
• Framer Motion - Animation library for React

Development & Testing

• Storybook - Component development environment
• Playwright - End-to-end testing framework
• ESLint - JavaScript/TypeScript linting
• Prettier - Code formatting

Backend & Services

• Supabase - Backend-as-a-Service (database, auth, storage)
• Sentry - Error monitoring and performance tracking

Package Management

• pnpm - Fast, disk space efficient package manager
• Corepack - Node.js package manager management

Additional Libraries

• React Hook Form - Forms with easy validation
• Zod - TypeScript-first schema validation
• React Table - Headless table library
• React Flow - Interactive node-based diagrams
• React Query - Data fetching and caching
• React Query DevTools - Debugging tool for React Query

Development Tools

• NEXT_PUBLIC_REACT_QUERY_DEVTOOL - Enable React Query DevTools. Set to true to enable.