Installation & local setup
Set up your machine to work on an Alloy project locally, and (for contributors) run Alloy itself in mock mode without any real accounts.
Your machine
| Tool | Version | Check with |
|---|---|---|
| Node.js | 20+ (22 recommended) | node -v |
| npm | 10+ | npm -v |
| Git | any recent version | git --version |
| Editor | VS Code, Cursor, WebStorm… |
A generated project
git clone https://github.com/<you>/<repo>.git
cd <repo>
npm install
npm run devThe dev server prints a local URL (usually http://localhost:5173). Changes you save reload instantly.
Useful scripts
| Script | What it does |
|---|---|
npm run dev | Development server with hot reload |
npm run build | Type-check and production build into dist/ |
npm run preview | Serve the production build locally |
npm run lint | Lint the code (when the project includes ESLint) |
Recommended editor setup
- Install the ESLint and Tailwind CSS IntelliSense extensions.
- Turn on "format on save".
- Open the project root so path aliases like
@componentsresolve.
Running Alloy itself (contributors)
Alloy runs fully offline in mock mode: a seeded demo user, mock AI responses and fake GitHub, GitLab and Bitbucket providers.
npm install
cp alloy.config.example.json alloy.config.json # gitignored, holds your local settings
npm run dev:mock