/rsv-dossier

FixMyCity's information website about planning and building cycle highways in Germany

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Netlify deployment status

This site show's general information about Radschnellverbindungen (cycle highways) in Germany and specific about specific highways which are planned or build.

💾 Data

TLDR: The (geo)data is available in the radschnellwege/ folder. If you use the data, attribute it like this:

© FixMyCity/RSV-Dossier - ODbL License

You find the geometry and meta information about the highways under ./src/radschnellwege/. There is one file for all highways in meta/ folder containing the meta information. In the geometry/ folder, every cycle highway has one individual file. In ./data/schema/you'll find the schema for the json files. It enables the validation of the files via gatsby.

See README.md for more details.

🧑‍💻 Developing

If you found any bugs feel free to create an issue.

Getting Started

For starting developing, the following steps could be helpful for getting started:

  • Use or nvm to install Node.js: nvm use
  • Install dependenices: npm install
  • Start gatsby develop service: npm start
  • Use npm run to see a list of commands
  • Use npm run build && npx serve public to test the build

We use husky to ensure commits don't include linting issues. If you use nvm, as suggested here, you should create a ~/.huskyrc. See docs

Setup your .env.development file, for which you can use .env.defaults as a start.

For production you will also need a .env.production file. Otherwise the modules using the env variables, will not work.

Gatsby KnowHow

License

This project has different licenses. The code is licensed under the AGPL-3.0 License - see the LICENSE.md file for more information. It contains dependencies which have different Licenses, see package.json.

For the license of the data, please see the specific README.md respectively LICENSE file.

Thanks