Use this template to create a your own repository.
If you haven't already, you'll need to create accounts for these services:
You will need to configure GitHub Pages to use the main branch and the /docs folder.
The easiest way to start is by simply creating a GitHub Codespace using this repository.
If you are not using Codespaces, to run locally you'll need to have the following dependencies installed:
After installing Git for the first time, you'll need to configure it by running the following from the VS Code integrated terminal (replace the quoted text with your name/email address):
git config --global user.name "<your name>"
git config --global user.email "<your email>"Then setup VSCode to start working:
- Install the GitHub Pull Requests and Issues VSCode Extension
- Clone the repository you've created from this template using VS Code
- Sign into GitHub with VS Code
- Install the package dependencies by running the following from the root directory of your cloned repository:
npm install
In order to use Mapbox services, you'll need to insert your Mapbox public access token (which can be found here) into src/settings.json.
To start the app, run the following from the root directory of your cloned repository:
npm start
The application should now be running at http://localhost:1234/ (see forwarded ports if using Codespaces).
Changes that you make to javascript and CSS files will be automatically refreshed.
Before deploying, you must first build the website by running the following command from the root directory:
npm run build
To deploy your latest code to the web, simply build (as per above) then commit and push your changes to the main branch in Github.