# Getting Started

> Create your first npm-factory project.

Source: https://npm-factory.n.yatsyk.com/docs/init/getting-started

# Getting Started

## 1. Create a new directory

```bash
mkdir my-sdk && cd my-sdk && git init
```

## 2. Run the scaffolder

```bash
npx @npm-factory/init
```

The wizard asks for:

* **Project id** — e.g. `my-sdk` (used in folder names, site title)
* **Scope** — e.g. `@my-org` (npm package scope)
* **Modules** — at least one (e.g. `core`). Each module becomes a publishable package.
* **Playground** — optional Next.js app for testing

## 3. Install and build

```bash
pnpm install
pnpm build
```

## 4. Start development

```bash
pnpm dev
```

This starts the docs site and playground (if configured) in parallel via Turbo.

## 5. Customize

Edit your DOT config at `packages/<project>-config/src/dot.ts`:

* Add or remove modules
* Set GitHub URL (`project.links.github`)
* Toggle API docs (`docs.apiDocs: "enabled" | "disabled"`)
* Change orphan mode for docs validation

Then rebuild: `pnpm build`