AutoGPT/autogpt_platform/frontend/README.md at 73a3d980cacee09872f83270f8a09e7421ad91d4

mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-06 22:03:59 -05:00

Files

Ubbe 73a3d980ca chore(frontend): move from yarn1 to pnpm (#10072 )

## 🧢 Overview
This PR migrates the AutoGPT Platform frontend from [yarn
1](https://classic.yarnpkg.com/lang/en/) to [pnpm](https://pnpm.io/)
using **corepack** for automatic package manager management.

**yarn1** is not longer maintained and a bit old, moving to **pnpm** we
get:
- ⚡ Significantly faster install times,
- 💾 Better disk space efficiency,
- 🛠️ Better community support and maintenance,
- 💆🏽‍♂️  Config swap very easy

##  🏗️ Changes

### Package Management Migration

- updated [corepack](https://github.com/nodejs/corepack) to use
[pnpm](https://pnpm.io/)
- Deleted `yarn.lock` and generated new `pnpm-lock.yaml`
- Updated `.gitignore`

### Documentation Updates

- `frontend/README.md`: 
  - added comprehensive tech stack overview with links
  - updated all commands to use pnpm
  - added corepack setup instructions
  - and included migration disclaimer for yarn users
- `backend/README.md`: 
  - Updated installation instructions to use pnpm with corepack
- `AGENTS.md`: 
  - Updated testing commands from yarn to pnpm

### CI/CD & Infrastructure

- **GitHub Workflows** : 
  - updated all jobs to use pnpm with corepack enable
  - cleaned FE Playwright test workflow to avoid Sentry noise
- **Dockerfile**:
- updated to use pnpm with corepack, changed lock file reference, and
updated cache mount path

###  📋 Checklist

#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
  
  **Test Plan:**
  > assuming you are on the `frontend` folder 
- [x] Clean installation works: `rm -rf node_modules && corepack enable
&& pnpm install`
  - [x] Development server starts correctly: `pnpm dev`
  - [x] Build process works: `pnpm build`
  - [x] Linting and formatting work: `pnpm lint` and `pnpm format`
  - [x] Type checking works: `pnpm type-check`
  - [x] Tests run successfully: `pnpm test`
  - [x] Storybook starts correctly: `pnpm storybook`
  - [x] Docker build succeeds with new pnpm configuration
  - [x] GitHub Actions workflow passes with pnpm commands

#### For configuration changes:
- [x] `.env.example` is updated or already compatible with my changes
- [x] `docker-compose.yml` is updated or already compatible with my
changes
- [x] I have included a list of my configuration changes in the PR
description (under **Changes**)

2025-06-04 17:07:29 +04:00

5.2 KiB

Raw Blame History

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.

Prerequisites

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

⚠️ Migrating from yarn

This project was previously using yarn1, make sure to clean up the old files if you set it up previously with yarn:
rm -f yarn.lock && rm -rf node_modules
Then follow the setup steps below.

Setup

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.
Install dependencies:
```
pnpm i
```
Start the development server:
```
pnpm dev
```

Open http://localhost:3000 with your browser to see the result.

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

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 type-check - Run TypeScript type checking
pnpm test - Run Playwright tests
pnpm test-ui - Run Playwright tests with UI

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

🚚 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

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

How to Use Storybook

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.
Build Storybook: To build a static version of Storybook for deployment, use:
```
pnpm build-storybook
```
Running Storybook Tests: Storybook tests can be run using:
```
pnpm test-storybook
```
For CI environments, use:
```
pnpm test-storybook:ci
```
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
Lucide React - Beautiful & consistent icons
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

5.2 KiB Raw Blame History