Skip to content
💬 An index of community resources for OpenStreetMap
Branch: master
Clone or download
Latest commit f2a7794 Feb 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.tx
dist
features add iran telegram, aparat, forum Jan 17, 2019
i18n
resources
schema Add `aparat` to resource schema and use it for osm-iran-aparat Jan 19, 2019
test Generate UMD export, ES6 module.. Add tests Mar 14, 2018
.eslintrc Initial checkin Mar 12, 2018
.gitignore ignore package-lock Apr 6, 2018
.npmignore ignore package-lock Apr 6, 2018
.travis.yml Travis matrix build Node 6, 8, 10 May 7, 2018
CHANGELOG.md v0.6.0 Jan 23, 2019
CODE_OF_CONDUCT.md Initial checkin Mar 12, 2018
CONTRIBUTING.md Add `aparat` to resource schema and use it for osm-iran-aparat Jan 19, 2019
ISSUE_TEMPLATE.md
LICENSE.md Initial checkin Mar 12, 2018
README.md
RELEASE.md Add note about CHANGELOG to release checklist Apr 4, 2018
build.js Show progress & summarry during Feature & Resource generation Jun 18, 2018
build_icons.js Add documentation, icons for all the new resources, add "osm" option Dec 3, 2018
index.mjs
package.json
rollup.config.js Actually it should be indent:'' May 17, 2018
stats.js Add `npm run stats` command to check file sizes Apr 5, 2018

README.md

npm version Build Status Greenkeeper badge

osm-community-index

💬 An index of community resources for OpenStreetMap.

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

The source files for this index are stored in two kinds of files:

  • Under features/ there are .geojson files to describe the areas where the communities are active
  • Under resources/ there are .json files to describe the community resources

👉 See CONTRIBUTING.md for info about how to add your community resource to this index.

tl;dr
  • Add a feature .geojson file under features/ folder
    • This is a boundary around where the resource is active
    • You can use geojson.io to create these
  • Add a resource .json file under resources/ folder
    • This contains info about what the resource is (slack, forum, mailinglist, facebook, etc.)
    • You can just copy and change an existing one
    • Several resources can share the same .geojson feature
  • npm run test
    • This will build and check for errors and make the files pretty

Prerequisites

  • Node.js version 4 or newer
  • git for your platform

Installing

  • Clone this project, for example: git clone git@github.com: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/).

You can’t perform that action at this time.