Make sure to install the dependencies.
mise trust # only needed once
mise install
pnpm installStart the development server on http://localhost:3000
pnpm devUse this step to build a local production version of the site. Use start to preview the local build.
pnpm build
pnpm startWe recommend to look at the documentation.
- Node.js >= 22
- mise
- pnpm >= 10
.github— GitHub configuration including the CI workflow..husky— Husky configuration and hooks.public— Static assets such as robots.txt, images, and favicon.src— Application source code, including pages, components, styles.cypress— End-to-end tests.
pnpm dev— Starts the application in development mode athttp://localhost:3000.pnpm build— Creates an optimized production build of your application.pnpm start— Starts the application in production mode.pnpm type-check— Validate code using TypeScript compiler.pnpm lint— Runs ESLint for all files in thesrcdirectory.pnpm format— Runs Prettier for all files in thesrcdirectory.pnpm cypress:run— Runs Cypress tests in headless mode.pnpm cypress:open— Opens Cypress in interactive mode.
TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.
import { Button } from '@/components/Button';
// Import images or other files from the public folder
import avatar from '@/public/avatar.png';This project is licensed under the MIT License - see the LICENSE.md file for more information.
Note: You will not need to do anything to the hosted site. Continuous Delivery has been setup with Vercel. All you need to do is push your commit and wait for it to deploy.