The purpose of this app is to allow for easier discovery of the educational modules created as part of the DART program. Ultimately this will replace the current public-facing list of all modules on the DART website.
This app will allow users to learn more about each module, investigate how the modules are connected, and search for particular topics or key words and build thier own pathways.
NOTE: This is a prototype that is in a phase of rapid development. All effort will be made to keep this README up to date, but some changes might slip by. If something isn't working as expected, please let us know by creating an issue.
A public prototype of this app is hosted at https://learn.arcus.chop.edu.
There are several top-level folders:
assetscontains the metadata for the educational modules that this app presents.componentscontains each of the panels/components of the app, both the visible and the hidden components. Any callbacks that are internal to a component, e.g. expanding and hiding the component or something within the component, is in the component's directory.callbackscontains any callbacks that transmit information between different components. All callbacks that update one of the app's hidden components are here.network_analysisis where the interconnections between modules are processed using thenetworkxpackage.
Two important python files are also at the top level:
app.pyis the python file which runs the app. It contains the visual layout of the components and calls all of the callbacks.module_data.pyis where metadata from the assets folder is processed into a single pandas dataframe for the app to use.
This application is built with Dash using Dash Bootstrap Components.
See requirements.txt for required packages.
The website https://learn.arcus.chop.edu is hosted using Google Cloud Run.
Clone or download this repository to run the app yourself!
The Dockerfile, requirements.txt are set up to allow this to run in a Docker container on a local computer. To run it, open Docker and a command line interface.
From the top level directory of this repository run:
docker build -t module_discovery_app .
This may take some a minute the first time you run it. Once it is completed, run:
docker run -d -p 8050:8050 module_discovery_app
Open a web browser to http://0.0.0.0:8050 to see and interact with the app.
If all of the requirements (see requirements.txt) are correct on your machine, you can run the app locally without using docker at all. From the top level directory of this repository, run:
python app.py
This will open a port where you can see the app locally. To see error messages, callbacks, and for the app to live update as you develop, set debug=True in the last line of app.py.
Data for this application comes from the Education Modules repository. If changes are made, say a new educational module is created, there are 3 steps to getting that module listed on the application's website, some automated and some manual.
The Process Module Metadata action is run every time there is a push to the main branch of the education_modules repository.
If any metadata has changed, the action updates the module_data.json file on the metadata_workflow branch.
Once a week the Update metadata from Education Modules repository action runs and if there has been any change to the module_data.json file on in the education_modules repository, the file /assets/module_data.json is updated here in the module_discovery repository.
Before updating the website at https://learn.arcus.chop.edu it is a good idea to manually run this action as well using the "Run Workflow" button to ensure that the most recent changes are captured.
Updating the GitHub repository does NOT update https://learn.arcus.chop.edu. Follow the instructions in the DENT - Module Discovery Operational Manual to deploy the application.
This application should be accessible to all users, whether they are accessing the website at https://learn.arcus.chop.edu or examining the documentation and code.
All screenshots should have descriptive alt text.
This is a Dash/Plotly app which has not yet been tested with any accessibilty technologies.
If you have needs that are not being met, or ideas for how to test or improve the accessibility of this app, please create an accessibility issue so we can work to address it!