Skip to content

Latest commit

 

History

History
103 lines (70 loc) · 5.11 KB

README.md

File metadata and controls

103 lines (70 loc) · 5.11 KB
Raw

All Contributors

TSB Tech-map

This is an open source React application that displays the technologies, tools, and hardware used by different teams of Technologiestifung Berlin in the form of a subway map. It uses a Leaflet map to provide an interactive and visual representation.

Features

  • Display of technologies, tools, and hardware used by a company
  • Interactive Leaflet map for a visually appealing representation
  • Easy generation of new stations using the /generator slug, which opens a UI to position the station
  • JSON data for stations can be easily added by copying and pasting into the equivalent file in the src/data folder

License

This project is licensed under the MIT License, making it free to use for everyone.

Tech stack

This project was bootstrapped with Create React App.

Installation

Node.js

This project is a Create-React-App which requires you to have Node.js installed.

Clone the repository to your local machine:

git clone [email protected]:technologiestiftung/Tech-Map.git

Move into the repository folder:

cd Tech-Map

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

Since our fonts are not free to use, you have to provide your own in the src/fonts folder and replace the @font-face... implementations in the src/styles/global.css.

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

npm start

Adding New Stations

To add new stations to the subway map, you can use 'http://localhost:3000/generator', which opens a UI for positioning the station. Simply copy and paste the generated JSON into the respective file in the src/data folder.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

ThorstenDiekhof
ThorstenDiekhof
👀		 Urs Schmidt
Urs Schmidt
💻 🤔 🖋		 Marco
Marco
🎨 🤔 🖋		 Matthieu Rigal
Matthieu Rigal
🤔 🖋		 JTaIoT
JTaIoT
🖋

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