# Getting Started

## Installing Node.js / NPM

To get started, install [Node.js](https://nodejs.org/en/) from Node's site, or [your package manager of choice](https://nodejs.org/en/download/package-manager/). For advanced usage [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm#installing-and-updating) may be useful.

**Optionally,** install `Yarn`, which tends to make dependency management a bit less painful. After installing `Node`/`npm`:

```bash
npm install --global yarn
```

## Starting your project

The easiest way to get started with your project is to go to the [webgeoda repo](https://github.com/GeoDaCenter/webgeoda) and click the *use this template* button. That will let you create a new GitHub repository based on the current WebGeoDa release. 

Once you have your GitHub repo started, clone the repository and open a terminal in your project folder. Run `npm install` to download the required modules.

## Required Environment Variables - Mapbox API Key

Mapbox tiles are the default background tiles for WebGeoDa scaffolding's maps. If you want to use [Mapbox](https://www.mapbox.com/), make an account and generate an API token. Then, create a file called `.env.local` in the project root folder with your API key as shown below:

```
NEXT_PUBLIC_MAPBOX_TOKEN=pk.abcdefg01189998819991197253...
```

## Starting the Dev Server

To run the local development server, open your terminal and get started like so:

{% tabs %}
{% tab title="Yarn" %}

```bash
yarn dev
```

{% endtab %}

{% tab title="NPM" %}

```bash
npm run dev
```

{% endtab %}
{% endtabs %}

## We're in.

You now have the basic WebGeoDa scaffolding ready to go! From here, why not [add some data](https://github.com/nofurtherinformation/webgeoda-gitbook/tree/b570c349ae9c0b81dd465bd8438485784f21956f/data/import.md), [customize static pages](https://github.com/nofurtherinformation/webgeoda-gitbook/tree/b570c349ae9c0b81dd465bd8438485784f21956f/pages/static/readme.md), or check out the default [file structure](https://github.com/nofurtherinformation/webgeoda-gitbook/tree/b570c349ae9c0b81dd465bd8438485784f21956f/data/file-structure.md) to see how things fit together?