EarthwormAI Frontend

Development

To start the project locally, run:

npm run dev

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

Documentation

Requirements

• Node.js >= 20.18.1
• npm >= 10.8.2

Directory Structure

• .github — GitHub configuration including the CI workflow.<br>
• .husky — Husky configuration and hooks.<br>
• public — Static assets such as robots.txt, images, and favicon.<br>
• src — Application source code, including pages, components, styles.

Scripts

• npm run dev — Starts the application in development mode at http://localhost:3000.
• npm run build — Creates an optimized production build of your application.
• npm run start — Starts the application in production mode.
• npm run type-check — Validate code using TypeScript compiler.
• npm run lint — Runs ESLint for all files in the src directory.
• npm run format — Runs Prettier for all files in the src directory.

Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.

// To import images or other files from the public folder
import avatar from '@/public/avatar.png'

import { Button } from '@/components/Button'

Switch to Yarn/pnpm

This starter uses npm by default, but this choice is yours. If you'd like to switch to Yarn/pnpm, delete the package-lock.json file, install the dependencies with Yarn/pnpm, change the CI workflow, and Husky Git hooks to use Yarn/pnpm commands.

Note: If you use Yarn, make sure to follow these steps from the Husky documentation so that Git hooks do not fail with Yarn on Windows.

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for more information.