osmlab / Osm Community Index
Programming Languages
Labels
Projects that are alternatives of or similar to Osm Community Index
osm-community-index
π¬ An index of community resources for OpenStreetMap.
- View the map of OpenStreetMap communities: https://openstreetmap.community
- Or search and filter the community resources: https://community.osm.be/
What is it?
This project is a list of resources for users of OpenStreetMap.
"Resources" can be links to forums, meetups, Slack groups, IRC channels, mailing lists, and so on. Anything that mappers, especially beginners, might find interesting or helpful.
About the index
tl;dr
To add your community resource to the index:
- Add resource
.json
files under theresources/
folder- Each file contains info about what the resource is (slack, forum, mailinglist, facebook, etc.)
- Each file also contains info about which locations the resource is active. The locations can be country or region codes, points, or custom
.geojson
files in thefeatures/*
folder. - You can copy and change an existing file to get started.
- run
npm run test
- This will check the files for errors and make them pretty.
- If you don't have Node installed, you can skip this step and we will do it for you.
- If there are no errors, submit a pull request.
Source files
The source files for this index are stored in two kinds of files:
- Under
resources/
there are.json
files to describe the community resources - Under
features/
there are custom.geojson
files
π See CONTRIBUTING.md for full details about how to add a community resource to this index.
Distributed Files
Several files are published under dist/
. These are generated - do not edit them.
-
resources.json
- A JSON object containing only the community resources -
featureCollection.json
- A GeoJSON FeatureCollection containing only the custom Features -
completeFeatureCollection.json
- A GeoJSON FeatureCollection of all Features, each with available resources included in aresources
property. -
img/*
- SVG logos for all the resource types
π§: "Why use .json
instead of .geojson
as the file extension for generated GeoJSON files?"
π€: "So you can require
or import
them as modules into other JavaScript code if you want."
Prerequisites
Installing
- Clone this project, for example:
git clone [email protected]:osmlab/osm-community-index.git
-
cd
into the project folder, - Run
npm install
to install libraries
Building
- Just
npm run test
- This will check the files for errors and make them pretty.
License
osm-community-index is available under the ISC License. See the LICENSE.md file for more details.
This project also bundles some icons from FontAwesome. The icons are licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).