https://github.com/technologiestiftung/organigramming-berlin

An online tool for creating and editing administrative organization charts in PDF format and machine-readable JSON format.
https://github.com/technologiestiftung/organigramming-berlin

odis open-data

Last synced: 30 days ago
JSON representation

An online tool for creating and editing administrative organization charts in PDF format and machine-readable JSON format.

• Host: GitHub
• URL: https://github.com/technologiestiftung/organigramming-berlin
• Owner: technologiestiftung
• License: mit
• Created: 2021-12-06T14:09:21.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T08:42:06.000Z (3 months ago)
• Last Synced: 2024-09-18T11:29:51.397Z (3 months ago)
• Topics: odis, open-data
• Language: JavaScript
• Homepage: https://organigramme.odis-berlin.de/
• Size: 9.83 MB
• Stars: 10
• Watchers: 8
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Built%20with%20%E2%9D%A4%EF%B8%8F-at%20Technologiestiftung%20Berlin-blue)

# Organigramm-Tool

**Notice: This application and the documentation is still a work in progress.**

## A simple organisation chart application for public service of Berlin

This repository contains an app for creating and editing administrative organization charts in machine-readable json format and as a graphical representation in pdf format. The online tool was developed with the aim to provide a simple yet sufficient tool to create organisational charts to export human as well as machine readable files.

Until now, the organization charts of Berlin's administrative units are created with Excel or PowerPoint and published in pdf format. On the one hand, their graphical format makes them easy for people to read. On the other hand, this means that they cannot be read by machines or code, or can only be read inadequately. However, the organigrams contain a lot of valuable information and a machine-readable preparation could enable various uses and applications.

The json file format allows the data entered to be stored in a simple text format and made available as Open Data. The organizational chart tool also aims to simplify the creation of organizational charts for the Berlin administration and to bring the organizational charts into a more uniform format.

More information and the protoype is accessible through the [ODIS website](https://odis-berlin.de/projekte/organigramme/) (only in German).

## Getting Started

Clone this repository, go to the directory `app` by:

`cd app`

Then install the required dependencies with:

`yarn install`

## Development

To run the app in the development mode run:

`yarn start`

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\

You will also see any lint errors in the console.

## Production

To build the app for production to the `build` folder run:

`yarn build`

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\

Your app is ready to be deployed!

## Development Notes

### Schema

The Charts data structure is defined in [organization_chart.json](./app/src/schemas/organization_chart.json).

### UI Schema

The Organisation UI schema is defined in the [OrganisationTab.js](./app/src/components/Sidebar/OrganisationTab.js) component.

The document UI schema is defined in the [DocumentTab.js](./app/src/components/Sidebar/DocumentTab.js) component.

### Validation rules

If you want to add validation rules you will need to add a new rule to [validationRules.js](./app/src/validation/validationRules.js)

If its a new set of validation rules (e.g. for a specific organisation), you will also need to add the key name of the organisation to the schema in your [organization_chart.json](./app/src/schemas/organization_chart.json)

You can add validation rules to any property from the list of available properties listed in [validationRules.js](./app/src/validation/validationRules.js) by adding a regex and a waring message.

### Updating RDF vocabulary

New vocabulary should be added to [typeVocabLookup.json](./app/src/services/typeVocabLookup.json)

## Acknowledgement

This project relies on the projects of Dabeng's [react-orgchart](https://github.com/dabeng/react-orgchart) and therefore on its precursor, Wesnolte's [jOrgChart](https://github.com/wesnolte/jOrgChart).

The icons used in this app came from [icons.getbootstrap.com/](https://icons.getbootstrap.com/).

The included files of Berlin's coats of arms came from [https://de.wikipedia.org/wiki/Liste_der_Wappen_in_Berlin](https://de.wikipedia.org/wiki/Liste_der_Wappen_in_Berlin).

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Lisa-Stubert
💻 🔣

      
Ester
💻 🔣

      
tihartma
💻

      
Dennis Ostendorf
💻

      
Lucas Vogel
📖

      
Fabian Morón Zirfas
🚇

      
Max B. Eckert
💻

    

    

      
Hans Hack
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Credits

  

    

      

        


        


        

      

    

    

      Together with: 

        


        


        

      

    

    

      A project by: 

        


        


        

      

    

     

      Supported by