> For the complete documentation index, see [llms.txt](https://totalsoft.gitbook.io/graphql-rocket-generator/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://totalsoft.gitbook.io/graphql-rocket-generator/quick-start.md).

# Quick Start

## Installation

First, install [Yeoman](http://yeoman.io/) and **@totalsoft/generator-graphql-rocket**, we assume you have pre-installed [NodeJS Latest LTS Version](https://nodejs.org/)(>=v14.15.0) and the npm version supported by your installed NodeJS version (*e.g. NodeJS Latest LTS Version: 14.17.1 (includes npm 6.14.13)*).

```
npm install -g yo
npm install -g @totalsoft/generator-graphql-rocket
```

OR

```
yarn global add yo
yarn global add @totalsoft/generator-graphql-rocket
```

## Generate new project

To scaffold your new GraphQL server using the generator go to:

{% content-ref url="/pages/n2GLn7cMFyPet8JasXjh" %}
[Generate new project](/graphql-rocket-generator/quick-start/generate-new-project.md)
{% endcontent-ref %}

## Upgrade existing project

To upgrade an existing project that was scaffold using this **GraphQL Rocket Generator**, see section:

{% content-ref url="/pages/pBoPAvGEUGdPfmb8C2EE" %}
[Upgrade existing project](/graphql-rocket-generator/quick-start/upgrade-existing-project.md)
{% endcontent-ref %}