autogpt_platform/frontend/README.md
This is the frontend for AutoGPT's next generation
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.
Make sure you have Node.js 16.10+ installed. Corepack is included with Node.js by default.
corepack enable
This enables corepack to automatically manage pnpm based on the packageManager field in package.json.
pnpm i
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.
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.
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.
pnpm dev - Start development serverpnpm build - Build for productionpnpm start - Start production serverpnpm lint - Run ESLint and Prettier checkspnpm format - Format code with Prettierpnpm types - Run TypeScript type checkingpnpm test - Run Playwright testspnpm test-ui - Run Playwright tests with UIpnpm fetch:openapi - Fetch OpenAPI spec from backendpnpm generate:api-client - Generate API client from OpenAPI specpnpm generate:api - Fetch OpenAPI spec and generate API clientThis project uses next/font to automatically optimize and load Inter, a custom Google Font.
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.
See CONTRIBUTING.md for feature flag usage patterns, local development with mocks, and how to add new flags.
TODO
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.
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
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.
NEXT_PUBLIC_REACT_QUERY_DEVTOOL - Enable React Query DevTools. Set to true to enable.