Getting Started

Creating an Analog project can be done with minimal steps.

System Requirements

Analog requires the following Node and Angular versions:

• Node 22 and higher is recommended
• Angular v17 or higher

Creating a New Application

To create a new Analog project, you can use the create-analog package with your package manager of choice:

npm create analog@latest

yarn create analog

pnpm create analog

bun create analog

You can also scaffold a new project with Nx.

Serving the application

To start the development server for the application, run the start command.

npm run start

yarn start

pnpm start

bun start

Visit http://localhost:5173 in your browser to view the running application.

Next, you can define additional routes using components for navigation.

Building the Application

To build the application for deployment

npm run build

yarn build

pnpm run build

bun run build

Build Artifacts

By default, Analog comes with Server-Side Rendering enabled. Client artifacts are located in the dist/analog/public directory. The server for the API/SSR build artifacts is located in the dist/analog/server directory.

Migrating an Existing Application

You can also migrate an existing Angular application to Analog. See the migration guide for migration steps.