This project was developed in the module "Wissenschaftskommunikation im MINT-Bereich" at the TU Berlin. It is a web application designed to help users to present their content in a more interesting way by filling in a questionnaire that shows possible media for communication as a result. The user can then read through additional tips and information on each medium and receives a leaflet with basic tips for good science communication.
This section explains technical details, that are relevant to run, repoduce, or modify this application.
This project runs on Node v11.0.0. VS Code was used as IDE.
The main dependencies used in this project are ChakraUI
for UI components and react-step-wizard
to implement the questionaire.
First, you need to clone this repository on your local machine.
Run locally with: npm start
- Commit and push changes to GitHub repository in main branch
- Deploy to GitHub Pages using:
npm run deploy
- After a successfull deployment you may need to wait a few minutes in order to see the changes.
- Check https://svfs-tuberlin.github.io/Wissenschaftskommunikation-im-MINT-Bereich/ if the changes were deployed and the application is still running correctly.
The /public
folder contains media files like images, PDF files and the introduction video.
The /src
folder contains the source code for the Medienkompass.
The code for the start page is located in the /src/myComponents/Home.jsx
file.
The code for the questionare is located in following files:
src/myComponents/Wizard.jsx
src/myComponents/steps/Questionare.jsx
src/myComponents/steps/Goal.jsx
andsrc/myComponents/steps/Group.jsx
The information about the questions, corresponding answers, and media types are stored in the files src/myComponents/media.json
and src/myComponents/topics.json
.