sm-heard / web-ui

MapsIndoors Web UI

This monorepo contains all UI projects for the MapsIndoors platform for Web. It is managed with Lerna, which makes it easier to work with multiple connected projects in one repo, like this.

Quickstart

The most interesting part of this repository is the Map Template. Get it up and running like so:

$ git clone https://github.com/MapsPeople/web-ui.git
$ cd web-ui && npm install && npx lerna run build
$ cd packages/map-template && npm run start

Open your browser on http://localhost:3000/ to check it out.

How the repo is set up

The repo consists of these packages, which are all found in the packages folder:

• components, the MapsIndoors Web Components found at @mapsindoors/components
• demos, a collection of demos of how to use the packages in this repo
• map-template, the MapsIndoors Map Template, a React app helping you get up and running fast and easy. It can be found at @mapsindoors/map-template
• midt, i.e. MapsIndoors Design Tokens, a design library used as the foundation for UI styles across MapsIndoors. It can be found at @mapsindoors/midt

A quick primer on Lerna

Built on top of npm's Workspaces feature, Lerna makes sure you install the packages defined in each individual package's package.json. In this case, from components, map-template and midt. At the same time, you install the latest version of each of those projects so you can work with them across your packages in this repo. We often make changes to components we need for a feature in the map-template project. Using Lerna, we don't have to deal with npm link, but can work on one feature across projects easily.

Conventional Commits

We use, and heavily rely on, the use of Conventional Commits.

Conventional Commits lets us write commits in a standardized fashion, no matter the contributor, and since we follow Semantic Versioning, we can keep everything in check more easily following the standards.

If your contribution to this repository doesn't follow these standards, it might be rejected, so please familiarize yourself with them before opening Pull Requests.

Updating the CHANGELOG

When creating a new Pull Request, you must give it a label of major, minor or patch depending on the nature of the code. You can read more about it on the link mentioned above on Semantic Versioning.

When the Pull Request has been approved, the CHANGELOG file must be updated. If multiple projects have been worked on, the CHANGELOG for each project needs to be updated. For now, the label applies for all the projects that have been worked on (i.e. work has been done on both the Map Template and the Components folder, and the label is minor, then the CHANGELOG for both projects need to be updated with a minor change.)