Docs/Installation

Installation

Download the template, install the dependencies and open the app on your machine. It takes about two minutes.

Requirements

  • Node.js 20.9 or newer
  • npm, pnpm, yarn or bun
  • Any editor; the repo includes an AGENTS.md for AI coding tools

Install and run

Unzip the download (or clone your access repository) and open the folder:

unzip accordee-app.zip && cd accordee-app

Install the dependencies:

npm install

Start the dev server, then open http://localhost:3000:

npm run dev

Log in with the demo account jane@locally.inc and the password “accordee”, or press Try out the demo.

Scripts

ScriptWhat it does
npm run devStart the dev server
npm run buildProduction build, every page pre-rendered
npm run startServe the production build
npm run lintESLint with the Next.js and React Hooks rules
npm run typecheckGenerate route types and run tsc
npm run formatPrettier with Tailwind class sorting