# create-polygon

## Scaffolding Your First Polygonjs Project

> **Compatibility Note:**
> create-polygon requires [Node.js](https://nodejs.org/en/) version 14.18+, 16+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

With NPM:

```bash
$ npm create polygon@latest
```

With Yarn:

```bash
$ yarn create polygon
```

With PNPM:

```bash
$ pnpm create polygon
```

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Polygonjs + Vue project, run:

```bash
# npm 6.x
npm create polygon@latest my-polygon-app --template vue

# npm 7+, extra double-dash is needed:
npm create polygon@latest my-polygon-app -- --template vue

# yarn
yarn create polygon my-polygon-app --template vue

# pnpm
pnpm create polygon my-polygon-app --template vue
```

Currently supported template presets include:

-   `vanilla`
-   `vanilla-ts`
-   `three`
-   `three-ts`
-   `vue`
-   `vue-ts`
-   `react`
-   `react-ts`
-   `react-three-fiber`
-   `react-three-fiber-ts`

You can use `.` for the project name to scaffold in the current directory.