Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

Commit

Permalink
Add app overview and data source details #150 (#183)
Browse files Browse the repository at this point in the history
* Add app overview and data source details

* Condense info about fake data

* Remove "Python" from "Django" statement

* Fix description of fake data local DB

Co-Authored-By: Code Hugger (Matthew Jones) <[email protected]>

* Add info on cohort and cacheing in MySQL DB

Co-Authored-By: Code Hugger (Matthew Jones) <[email protected]>
  • Loading branch information
mfldavidson and jonespm authored Oct 23, 2019
1 parent 675c65e commit 15e49c4
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
# Student Explorer

## Overview

Student Explorer is an early warning system that helps academic advisors at the University of Michigan-Ann Arbor identify at-risk students based on current term Learning Management System data. It started in 2011 as a research project at the University of Michigan USE Lab; LSA Technology Services, Academic Innovation, and ITS Teaching & Learning have contributed to the design, development, and management of the tool. Student Explorer is in use as an enterprise production application at U-M and continues to be developed by ITS Teaching & Learning. The code is open source and is licensed under Apache 2.0. The application primarily relies on Django for the backend and Bootstrap and jQuery for the frontend.

- [About the Student Explorer Application](https://studentexplorer.ai.umich.edu/about)
- [Student Explorer Documentation](https://documentation.its.umich.edu/student-explorer-general)
- [Student Explorer Release Notes](https://github.com/tl-its-umich-edu/student_explorer/releases)

To contact the Student Explorer team, please email [email protected].

## Data Sources

Student Explorer uses two separate data sources in production:

1. A MySQL database, which contains administrative and management tables typical for Django databases, including django_admin_log (log of changes made in Django admin), tracking_event (log of events tracked in the application such as page views, logins, and redirects), and auth_user (user accounts). This database also maintains the cohort relationships and is being used to cache page templates to improve performance.

2. U-M Data Warehouse Oracle database edwprod.world, which contains the data served up in the application, including basic student and course data, grades, assignments, etc. For full information on the tables in the U-M Data Warehouse that are used by Student Explorer, see [Teaching & Learning Student Explorer dataset information.](https://its.umich.edu/enterprise/administrative-systems/data-warehouse/data-areas/teaching-learning#student-explorer)

Note that when you follow the instructions below to start up a local version of the application, both data sources will be created in the same MySQL database and populated with fake data. This data will help demonstrate the tool's functionality.

## Development Environment

### Application Setup

To follow these instructions, you will need to have [Docker](https://www.docker.com/) installed. For those new to the
technology, the [documentation](https://docs.docker.com/) includes a detailed introduction. When following the below
instructions, the application will use fake prepared data to help demonstrate the tool's functionality.
technology, the [documentation](https://docs.docker.com/) includes a detailed introduction.

1. Clone and navigate into the repository.

Expand Down Expand Up @@ -65,4 +84,4 @@ By default, Django's `manage.py` process looks for the `student_explorer.local.s
created automatically when using `docker-compose` based on instructions in the `Dockerfile`. In addition, `wsgi.py`
(which is used by `start.sh`) looks by default for the `student_explorer.settings` module. This file is versioned as
part of the repository. This behavior can be changed for both `manage.py` and `wsgi.py` by setting the
`DJANGO_SETTINGS_MODULE` environment variable.
`DJANGO_SETTINGS_MODULE` environment variable.

0 comments on commit 15e49c4

Please sign in to comment.