We would love for you to contribute to basemaps and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
This repository requires NodeJs > 18
Use n or fnm to manage nodeJs versions
# Download the latest nodejs
n latest
# Install node deps
npm install
# Build everything into /build
npm run build
# Run the unit tests
npm run testFor a fresh rebuild
npm run cleanthis repository is a monorepo for everything related to basemaps
- @basemaps/test - Testing utilities and assets
- @basemaps/infra - Infrastructure code using AWS CDK
- @basemaps/attribution - Calculate the attribution for given map location
- @basemaps/bathymetry - Convert bathymetry from GEBCO into colorized HillShade geotiff.
- @basemaps/cli - cli that using for CICD process
- @basemaps/cogify - CLI to re-tile imagery into a Cloud Optimised Geotiffs (COG)
- @basemaps/config - Configurations for Basemaps system
- @basemaps/geo - Utility to work with QuadKeys, Tiles and Projections.
- @basemaps/lambda-analytics - Generate analytics from CloudFront distribution statistics
- @basemaps/lambda-tiler - Lambda server for WMTS/XYZ map generation
- @basemaps/landing - The landing page for Basemaps
- @basemaps/server - cli for WMTS/XYZ Tile server
- @basemaps/shared - Shared Utilities for other Basemaps packages
- @basemaps/smoke - Smoke tests
- @basemaps/sprites - sprite sheet generation
- @basemaps/tiler - Compose CogGeoTiffs for xyz tile server
- @basemaps/tiler-sharp - Generate tiles by using sharp and libvips
- @linzjs/docker-command - Utilities for running commands inside Docker
- @linzjs/geojson - Utility for working with GeoJSON
- @linzjs/metrics - Simple timing metric tracker for NodeJS
This repository uses Conventional Commits
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log.
Must be one of the following:
- build: Changes that affect the build system or external dependencies
- ci: Changes to our CI configuration files and scripts
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code
- test: Adding missing tests or correcting existing tests