An interactive, self-service map showcasing members of your GitHub organization.

User pins are managed via GitHub Actions. Please see about.md for information. Do not open a pull request.

The main branch of the repository contain all the tooling needed to manage maps. In your fork, do not modify the main branch, and only commit changes in the gh-pages branch. This will allow you to sync updates and fixes submitted upstream in your fork easily.

1. Fork this repository to your organization;
2. Enable workflow on your fork: Actions / I understand my workflows, go ahead and enable them (if you do not do this now, the following step will prevent your from being able to do it later);
3. Create a branch gh-pages: Branches / new Branch / New branch name: gh-pages, Source: main;
4. Make gh-pages the default branch of your fork: Settings / General / Default branch;
5. In the gh-pages branch: adjust your repo url, community name, description in _config.yml;
6. Collect and setup the required API keys (see bellow);
7. Make sure your community members are allowed to trigger GitHub actions in your repository so that they can add their location to the map in self-service mode.

1. Synchronize the main branch of your fork with the upsteam repository;
2. Merge the main branch of your fork into the gh-pages branch of your fork.

This project rely on 2 external services for geocoding (turning an address into a latitude and longitude) and for map tiles. Both provide a generours free tier which should be enough for most uses.

The free tier allow 3000 geocoding / day, which should be more than enough for almost any projects.

1. On https://myprojects.geoapify.com/:
   1. Create an account;
   2. Add a new project (e.g. map);
   3. Copy the API key;
2. On your GitHub fork of this project:
   1. Add a repository secret (Settings / Secrets and variables / Actions / New repository secret);
   2. Name it GEOAPIFY_KEY;
   3. Paste the API key as its value.

Thunderforest provide nice rendering of OpenStreetMap data. Their free tier offer 150,000 tile requests per month.

Warning: as this API key will be exposed, you should use a dedicated user account and not re-use a key from another project.

1. On https://manage.thunderforest.com/users/sign_in:
   1. Create an account;
   2. Copy your API key from the dashboard.