This is the frontend for AutoGPT's next generation ## ๐Ÿงข Getting Started This project uses [**pnpm**](https://pnpm.io/) as the package manager via **corepack**. [Corepack](https://github.com/nodejs/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: > > ```bash > rm -f yarn.lock && rm -rf node_modules > ``` > > Then follow the setup steps below. ### Setup 1. **Enable corepack** (run this once on your system): ```bash corepack enable ``` This enables corepack to automatically manage pnpm based on the `packageManager` field in `package.json`. 2. **Install dependencies**: ```bash pnpm i ``` 3. **Start the development server**: ```bash pnpm dev ``` Open [http://localhost:3000](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: ```bash 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`](https://nextjs.org/docs/basic-features/font-optimization) 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 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: ```bash pnpm storybook ``` This will start Storybook on port 6006. Open [http://localhost:6006](http://localhost:6006) in your browser to view your component library. 2. **Build Storybook**: To build a static version of Storybook for deployment, use: ```bash pnpm build-storybook ``` 3. **Running Storybook Tests**: Storybook tests can be run using: ```bash pnpm test-storybook ``` For CI environments, use: ```bash pnpm test-storybook:ci ``` 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**](https://nextjs.org/) - React framework with App Router - [**React**](https://react.dev/) - UI library for building user interfaces - [**TypeScript**](https://www.typescriptlang.org/) - Typed JavaScript for better developer experience ### Styling & UI Components - [**Tailwind CSS**](https://tailwindcss.com/) - Utility-first CSS framework - [**shadcn/ui**](https://ui.shadcn.com/) - Re-usable components built with Radix UI and Tailwind CSS - [**Radix UI**](https://www.radix-ui.com/) - Headless UI components for accessibility - [**Lucide React**](https://lucide.dev/guide/packages/lucide-react) - Beautiful & consistent icons - [**Framer Motion**](https://motion.dev/) - Animation library for React ### Development & Testing - [**Storybook**](https://storybook.js.org/) - Component development environment - [**Playwright**](https://playwright.dev/) - End-to-end testing framework - [**ESLint**](https://eslint.org/) - JavaScript/TypeScript linting - [**Prettier**](https://prettier.io/) - Code formatting ### Backend & Services - [**Supabase**](https://supabase.com/) - Backend-as-a-Service (database, auth, storage) - [**Sentry**](https://sentry.io/) - Error monitoring and performance tracking ### Package Management - [**pnpm**](https://pnpm.io/) - Fast, disk space efficient package manager - [**Corepack**](https://github.com/nodejs/corepack) - Node.js package manager management ### Additional Libraries - [**React Hook Form**](https://react-hook-form.com/) - Forms with easy validation - [**Zod**](https://zod.dev/) - TypeScript-first schema validation - [**React Table**](https://tanstack.com/table) - Headless table library - [**React Flow**](https://reactflow.dev/) - Interactive node-based diagrams