[[TOC]]
- Linus Meierhöfer
- Tae Kim
- Igor Martinelli
- Nils Küstahler
Implement a website where information about transportation with reducced mobility is accessible and centralized to make it easier for them to navigate te city
People with disabilities or reduced mobility
Add here all used datasets.
Document here where to find the data and how to download it.
https://opendata.swiss/de/dataset/behindertenparkplatze\
https://opendata.swiss/de/dataset/bestandsaufnahme-behig\
https://data.stadt-zuerich.ch/dataset/vbz_fahrplandaten_gtfs
Define all the tasks you want your dashboard solve.
Specify here the structure of you code and comment what the most important files contain
├── README.md
├── backend-project
│ ├── setup.py # main app
│ ├── .dockerignore
│ ├── Dockerfile
│ ├── MANIFEST.in
│ ├── README.md
│ ├── pyproject.toml
│ ├── data
│ │ ├── ames-housing-features.json
│ │ ├── ames-housing-gam-instance-data.json
│ │ └── ames-housing-gam.json
│ └── src/gamut_server
│ ├── resources
│ │ ├── __init__.py
│ │ ├── description.py
│ │ ├── features.py
│ │ └── instances.py
│ ├── router
│ │ ├── __init__.py
│ │ ├── app.py
│ │ └── routes.py
│ └── __init__.py
├── react-frontend
│ ├── README.md
│ ├── package-lock.json
│ ├── package.json
│ ├── src
│ │ ├── App.css
│ │ ├── App.test.tsx
│ │ ├── App.tsx
│ │ ├── Visualization.tsx
│ │ ├── backend
│ │ │ ├── BackendQueryEngine.tsx
│ │ │ └── json-decoder.ts
│ │ ├── components
│ │ │ ├── BasicLineChart
│ │ │ │ ├── BasicLineChart.scss
│ │ │ │ ├── BasicLineChart.tsx
│ │ │ │ └── types.ts
│ │ │ ├── DataChoiceComponent.tsx
│ │ │ ├── DataPointComponent.tsx
│ │ │ └── ScatterPlot
│ │ │ ├── ScatterPlot.scss
│ │ │ ├── ScatterPlot.tsx
│ │ │ └── types.ts
│ │ ├── index.css
│ │ ├── index.tsx
│ │ ├── logo.svg
│ │ ├── react-app-env.d.ts
│ │ ├── reportWebVitals.ts
│ │ ├── setupTests.ts
│ │ └── types
│ │ ├── DataArray.ts
│ │ ├── DataPoint.ts
│ │ └── Margins.ts
│ └── tsconfig.json
└── requirements.txt
Write here all intructions to build the environment and run your code.
NOTE: If we cannot run your code following these requirements we will not be able to evaluate it.
Write here DETAILED intructions on how to run your code.
NOTE: If we cannot run your code following these instructions we will not be able to evaluate it.
As an example here are the instructions to run the Dummy Project: To run the Dummy project you have to:
- clone the repository;
- open a terminal instance and using the command
cd
move to the folder where the project has been downloaded;
To run the backend
- open the backend folder called "backend-project"
- to start the backend first you need to create a virtual environment using conda
conda create -n nameOfTheEnvironment
- to activate the virtual environment run the command
conda activate nameOfTheEnvironment
- install the requirements using the command
pip3 install .
- If you want to make changes and test them in real time, you can install the package in editable mode using the command
pip install -e .
- to start the backend use the command
python3 -m gamut_server.router.app
or use thestart-server
command directly on your terminal
- to activate the virtual environment run the command
To run the frontend
- Open a new terminal window and go to the project folder
- Enter the frontend folder called "react-frontend"
- Do the following command to start the front end
npm install
,npm start
If all the steps have been successfully executed a new browser window witht he dummy project loaded will open automatically.
Document here the major milestones of your code and future planned steps.\
Create a list subtask.
Open an issue for each subtask. Once you create a subtask, link the corresponding issue.
Create a merge request (with corresponding branch) from each issue.
Finally accept the merge request once issue is resolved. Once you complete a task, link the corresponding merge commit.
Take a look at Issues and Branches for more details.
This will help you have a clearer overview of what you are currently doing, track your progress and organise your work among yourselves. Moreover it gives us more insights on your progress.
Write here a short summary with weekly progress, including challanges and open questions.
We will use this to understand what your struggles and where did the weekly effort go to.
Create stable versions of your code each week by using gitlab tags.
Take a look at Gitlab Tags for more details.
Then list here the weekly tags.
We will evaluate your code every week, based on the corresponding version.
Tags:
- Week 1: Week 1 Tag
- Week 2: ..
- Week 3: ..
- ...