WebgeoDa Scaffolding
More Maps. Fewer Platforms.
1.0.0
1.0.0
  • About Webgeoda Scaffolding
  • Data Concepts
  • Getting Started
  • Libraries and Dependencies
  • File Structure Overview
  • Data
    • Importing Data
    • Accessing Exernal Data
    • Making an API
  • Variables
    • Overview
    • Continuous
    • Categorical
    • LISA
    • Colors
    • Variable Specification
  • Static Pages
    • Adding and Customizing Pages
    • Styling and CSS Modules
  • Map Customization
    • Changing the Background Map Tiles
    • Visualization Modes
    • Change Tooltip and Data Sidebar Information
    • Modifying Layers
  • Widgets
    • Data Exploration Widgets
    • Widget Layouts
  • Deploying
    • Netlify
    • Vercel
    • Github Pages (or elsewhere)
  • Advanced
    • jsGeoDa
    • Next.JS
    • Alternate Map Views
    • Binary Data Formats
Powered by GitBook
On this page
  • Installing Node.js / NPM
  • Starting your project
  • Required Environment Variables - Mapbox API Key
  • Starting the Dev Server
  • We're in.

Was this helpful?

Getting Started

Let's do this thing.

PreviousData ConceptsNextLibraries and Dependencies

Last updated 3 years ago

Was this helpful?

Installing Node.js / NPM

To get started, install from Node's site, or . For advanced usage may be useful.

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

npm install --global yarn

Starting your project

The easiest way to get started with your project is to go to the 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 , 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 dev
npm run dev

We're in.

You now have the basic WebGeoDa scaffolding ready to go! From here, why not , , or check out the default to see how things fit together?

Node.js
your package manager of choice
Node Version Manager (nvm)
webgeoda repo
Mapbox
add some data
customize static pages
file structure