IHS Mapbox Template

Version 2 of the template for DePaul Institute for Housing Studies MapBox maps.

Development

Setup

Pre-commit

Pre-commit hooks are scripts that run on your local machine before every commit.

We use the pre-commit framework to run code linters and formatters that keep our codebase clean.

To set up Pre-Commit, install the Python package on your local machine using:

python -m pip install pre-commit

If you'd rather not install pre-commit globally, create and activate a virtual environment in this repo before running the above command.

Then, run:

pre-commit install

Since hooks are run locally, you can modify which scripts are run before each commit by modifying .pre-commit-config.yaml.

Usage

Running the app

To start this app locally, run python3 -m http.server from the root directory.

Managing site styles

TODO: details