Getting Started

Let's do this thing.

Installing Node.js / NPM

To get start, install Node.js from Node's site, or your package manager of choice. For advanced usage Node Version Manager (nvm) may be useful.

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

npm install --global yarn

Installing Degit

The easiest way to get start with WebGeoDa scaffolding is with Degit. Install Degit with:

npm i -g degit

Alternatively you can fork the repository directly @nofurtherinformation/webgeoda.

Scaffolding Your Project

Next, in your terminal, you can create a new WebGeoDa scaffolding like this:

Yarn

npx degit nofurtherinformation/webgeoda my-webgeoda-project
cd my-webgeoda-project

yarn

NPM

npx degit nofurtherinformation/webgeoda my-webgeoda-project
cd my-webgeoda-project

npm install

Mapbox API Key

Mapbox tiles are the default background tiles for WebGeoDa scaffolding's maps. If you want to use Mapbox, 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:

Yarn

yarn dev

NPM

npm run dev

We're in.

You now have the basic WebGeoDa scaffolding ready to go! From here, why not add some data, customize static pages, or check out the default file structure to see how things fit together?