Branchen Puls

This application is a prototype. It may contain errors and small bugs. If you notice something you can report an Issue. Thank you!

BranchenPuls is based on open data from the Berlin Chamber of Commerce and Industry (IHK Berlin) and contains information about around 350.000 member companies like the business geolocation, the specific business field, founding date or the approximate number of employees. With the help of BranchenPuls you can not only see the business concentration in Berlin but also explore the data set by setting different filters. For example you can filter all companies in a specific business field in a spatial unit like the berlin districts. The data set will be updated monthly starting in july 2023 which allows you to follow the development of Berlins business over time.

Context

This application is based on open data. Open data is an important part of Berlin's administrative activities and on top of creating transparency, enables analysis and applications like this. You can find more open data at the Berlin Open Data Portal. The Berlin Chamber of Commerce and Industry as an important stakeholder in the berlin open data ecosystem and is committed to publish open data also to convince other stakeholder to open their data as a benefit for everyone. If you are interested to learn more about the activities or if you have any questions you can contact directly the data management team.

Tech stack

This website is a NextJS app configured with:

• Typescript
• Linting with ESLint
• Formatting with Prettier

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 installed.

Installation

Clone the repository to your local machine:

git clone [email protected]:technologiestiftung/ihk-vis.git

Move into the repository folder:

cd ihk-vis

Make sure you use the Node.js version specified in .nvmrc. Find out which Node version you're currently on with:

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, which allows switching to the correct version via:

nvm use

With the correct Node version, install the dependencies:

npm install

Because the map uses a basemap from maptiler (https://www.maptiler.com/) and data via Supabase, you will need to provide connection details in your environment. In this repository you can find a file .env.example. Duplicate this file and name it .env.

In .env you must enter the connection details suggested in .env.example. If you do not know how to obtain the necessary details, please ask a repository maintainer for access. You can also use other basemaps by providing your own style file.

You are now ready to start a local development server on http://localhost:3000 via:

npm run dev

Data

You can find the raw data on the IHK Gewerbedaten Github repo

Backend

The data displayed is hosted on Supabase - a service that allows you to host a PostgreSQL database and query it via an API. More information on how to import the raw data into a PostgreSQL database can be found in this repository.

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 <name-of-your-branch> to create a new branch (ideally following Conventional Commits guidelines).
• 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 Netlify.

Map

The basemap style was created with maptiler (https://www.maptiler.com/). Please note, that you need to update the MAPKEY with your own project's mapkey. You can also use any other basemap by adapting the code in the Map component.

Page analytics

We use Matomo 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.

Contributing

Before you create a pull request, write an issue so we can discuss your changes.

Contributors

Thanks goes to these wonderful people (emoji key):

Hans Hack 💻 📖	Lisa-Stubert 💻 📖	Fabian Morón Zirfas 💻 📖	anna 🎨	Klemens 🤔 🔣	Raphael.A 💻 👀	Jonas Jaszkowic 💻 👀
Dennis Ostendorf 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!

Content Licensing

Texts and content available as CC BY.

Credits

Made by:

Together with:

A project by:

Supported by