Getting started with Example in five minutes

If you are new to Example, this short guide will walk you through the core concepts you need to be productive in about five minutes.

1. Create a project

A project is the top-level container for everything you build with Example. It owns your environment variables, team members, and deploy history.

npx create-example my-first-project
cd my-first-project

2. Run it locally

Every project ships with a development command that mirrors what runs in production.

npm run dev

Open http://localhost:3000 in your browser and you should see the welcome screen.

3. Deploy

When you are ready, push to the main branch. A successful CI run will automatically roll out to your production environment.

git push origin main

That is it. From here, the announcements feed is the best place to keep up with new features, and the rest of the articles section dives deeper into specific workflows.