# Get started

Welcome to Shipped, the NextJS boilerplate to launch your SaaS in days!

**Shipped** code is on GitHub, so start by forking the repo.

If you have purchased the **Startup** package go to this page and click on the Fork button:

```bash
https://github.com/ShippedBoilerplate/shipped
```

If you have purchased the **Startup + Chrome Extension** package go to this page and click on the Fork button:

```bash
https://github.com/ShippedForBrowserExtensions/shipped-browser-extensions
```

In the fork form, select the owner (your GitHub user), uncheck the option "Copy the `main` branch only", and click on **Create fork**.

{% hint style="info" %}
**Why forking?**

When you create a fork, you own the new repository, while your fork keeps a link to the original repository.

This means that if I update the Shipped boilerplate code, you can integrate the latest changes with the click of a button.

In your repository, you will find a button on GitHub called "Sync Fork" that allows you to integrate the changes I make in the original repository at any time!
{% endhint %}

Now it's time to clone the forked repository.

Go to your forked repository on GitHub, click on the "Code" button, and select "Open with GitHub Desktop" for the easiest way to download the repository to your local computer.

<figure><img src="https://3985976695-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT3t4pDs63s3Soj1JetJw%2Fuploads%2FTyG3uJxtB7UQG2Nz3NA1%2Fimage.png?alt=media&#x26;token=0ad0987e-accb-4e58-9b66-00e05561bb21" alt=""><figcaption></figcaption></figure>

Instead, if you're familiar with the git CLI, use the command `git clone git@github.com:<your fork>`.

Finally open a terminal, go to the folder you cloned the repository into, and run:

{% code title="terminal" %}

```bash
cp .env.example .env # copy the env file
npm i # install the dependencies
npm run dev # start the local next.js server
```

{% endcode %}

At this point, your product is running at [`http://localhost:3000`](http://localhost:3000)

Point your browser to that page, and see it in action! 🚀

Pretty exciting, right?!

## Configuration

Check the [Configuration](https://docs.shipped.club/other/configuration) page to configure your web app (mandatory for most of the features).

## NodeJS Version

To correctly run Shipped, you need to use the version of NodeJS 20.10.0

To enforce it, the repository includes a `.nvmrc` file.

NVM is the Node Version Manager that you can download [here](https://github.com/nvm-sh/nvm).

To activate the correct NodeJS version, go to the Shipped folder and run

{% code title="terminal" %}

```bash
nvm install 20.10.0
nvm use
```

{% endcode %}

{% hint style="success" %}
**Pro tip** Install the [script to automatically switch nodejs version](https://github.com/nvm-sh/nvm#calling-nvm-use-automatically-in-a-directory-with-a-nvmrc-file) when you move to a folder with a `.nvmrc` file.
{% endhint %}

\
Common next steps:

* Configure a [database](https://docs.shipped.club/features/database)
* Configure [authentication](https://docs.shipped.club/features/authentication)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shipped.club/get-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.