Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/technologiestiftung/tarifkarte
A map visualising Berlin fare zones
https://github.com/technologiestiftung/tarifkarte
Last synced: 30 days ago
JSON representation
A map visualising Berlin fare zones
- Host: GitHub
- URL: https://github.com/technologiestiftung/tarifkarte
- Owner: technologiestiftung
- License: mit
- Created: 2023-02-13T12:16:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T23:38:44.000Z (2 months ago)
- Last Synced: 2024-10-24T16:21:26.463Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 8.53 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](#contributors-)
# Berliner Tarifkarte
Where exactly does Berlin's public transport fare zone C run? Which stations can you reach with a simple ABC ticket? Find out on this map.
## Context
This application is based on open data. Open data is an important part of Berlin's administrative activities and not only creates transparency and openness, but also enables analysis and applications like this. You can find more open data at the [Berlin Open Data Portal](https://daten.berlin.de).
## Data
Data used to create the map:
- [VBB-Fahrplandaten via GTFS](https://daten.berlin.de/datensaetze/vbb-fahrplandaten-gtfs)
- [VBB Alle Zielorte](https://www.vbb.de/fileadmin/user_upload/VBB/Dokumente/API-Datensaetze/vbb-alle-zielorte.csv)
## Tech stack
This website is a NextJS app configured with:
- [Typescript](https://www.typescriptlang.org/)
- Linting with [ESLint](https://eslint.org/)
- Formatting with [Prettier](https://prettier.io/)
## Project structure
Basic Next.js app
## Getting started
### Requirements
#### Node.js
This project is a Next.js app which requires you to have [Node.js](https://nodejs.org/en/) installed.
### Installation
Clone the repository to your local machine:
```bash
git clone [email protected]:technologiestiftung/tarifkarte.git
```
Move into the repository folder:
```bash
cd tarifkarte
```
Make sure you use the Node.js version specified in `.nvmrc`. Find out which Node version you're currently on with:
```bash
node --version
```
If this version differs from the one specified in `.nvmrc`, please install the required version, either manually, or using a tool such as [nvm](https://github.com/nvm-sh/nvm), which allows switching to the correct version via:
```bash
nvm use
```
With the correct Node version, install the dependencies:
```bash
npm install
```
You are now ready to start a local development server on http://localhost:3000 via:
```bash
npm run dev
```
## Workflow
New features, fixes, etc. should always be developed on a separate branch:
- In your local repository, checkout the `main` branch.
- Run `git checkout -b ` to create a new branch (ideally following [Conventional Commits guidelines](https://www.conventionalcommits.org)).
- Make your changes
- Push your changes to the remote: `git push -u origin HEAD`
- Open a pull request.
You can commit using the `npm run cm` command to ensure your commits follow our conventions.
## Deployment
The app is deployed to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
## Page analytics
We use [Matomo](https://matomo.org/) for website analytics. Matomo is respectful of the users' privacy, the page visits are tracked anonymously.
In the production environment, a `NEXT_PUBLIC_MATOMO_URL` and `NEXT_PUBLIC_MATOMO_SITE_ID` is configured for this purpose.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Content Licensing
Texts and content available as [CC BY](https://creativecommons.org/licenses/by/3.0/de/).
## Credits
Together with:
A project by:
Supported by:
