Getting Started
Learn how to install, configure, and build your first project with Acme in under 5 minutes.
Prerequisites
You need Node.js 18+ and npm 9+ installed. We recommend using nvm to manage Node versions.
Installation
Install Acme globally using your preferred package manager:
Terminal
npm install -g @acme/cli
# Or with pnpm
pnpm add -g @acme/cli
# Or with yarn
yarn global add @acme/cliCreate a New Project
Once installed, create a new project using the init command:
Terminal
acme init my-project
cd my-project
npm install
npm run devThis will scaffold a new project with the following structure:
Project Structure
my-project/
├── src/
│ ├── pages/
│ │ └── index.tsx
│ ├── components/
│ │ └── Layout.tsx
│ └── styles/
│ └── globals.css
├── public/
├── acme.config.ts
├── package.json
└── tsconfig.jsonConfiguration
The acme.config.ts file at your project root controls all framework behavior:
acme.config.ts
import { defineConfig } from '@acme/core';
export default defineConfig({
// Site metadata
site: {
title: 'My Project',
description: 'Built with Acme',
url: 'https://example.com',
},
// Enable features
features: {
typescript: true,
analytics: false,
imageOptimization: true,
},
// Build options
build: {
output: 'dist',
minify: true,
},
});Breaking Change in v2.4
The output option has moved from the top level to build.output. See the migration guide.
Next Steps
Now that you have a project running, explore these guides to learn more: