/studentinsights

Student Insights for Somerville educators

Primary LanguageRubyMIT LicenseMIT

Student Insights

Build Status Code Climate

Student Insights gives educators an overview of student progress at their school, classroom-level rosters and individual student profiles. It also allows them to capture interventions and notes during weekly or bi-weekly student support meetings focused on the most at-risk students.

Check out the demo site:

  • username: demo@example.com
  • password: demo-password

Our presentation at Code for Boston demo night in May 2016 also has a good product overview.

Table of Contents

User personas: Who we're serving

There are three main user personas we're serving. Principals, Interventionists and Classroom Teachers. Right now we're focused primarily on serving principals, and the rough progression will likely be to Interventionists next. Early adopter Classroom Teachers are great, but focused on scaling adoption across all classroom teachers isn't a priority yet.

Principals are responsible for a school, from ensuring all students are progressing academically to making hiring and staffing decisions for teachers.

Interventionists are typically folks who provide some kind of specialized service to students, like counseling, behavioral services or specialized reading instruction. They have caseloads of 20-70 students and are often involved in interdisciplinary teams focused on supporting students who are most at-risk.

Classroom Teachers are responsible for teaching all subjects in an elementary level, and at the middle school level typically teach two subjects, with a few periods of each subject.

Product overview: How we're helping

School overview

Principals and intervention specialists can get an overview of all students at school, updated automatically as new data comes in. This includes demographic information (left), academic progress indicators (center), and educational interventions (right).

Overview

Educators answer specific questions like "how are 3rd grade students doing on reading assessments?" and "are students on free lunch programs equitably distributed between 5th grade classrooms?" This is useful for understanding progress for groups of students, and also for identifying particular students in need of targeted interventions.

Filtering

Data can be exported as a CSV for more sophisticated analysis.

Classroom rosters

Classroom teachers can see rosters of all students in their classroom, calling out high-need students and letting them jump into the student's case history and record of previous assessments and interventions.

Rosters

Student profiles

Individual student profiles show how students are progressing on core academic skills, as measured summatively by MCAS or on more frequent formative measures like STAR assessments.

Profile

Student profiles also contain the full case history of demographic information, attendance and behavioral support.

Profile

We're working on some big improvements to the student profile page right now, check out #5 for more background.

Capturing meeting notes and interventions

It's one thing to have data, but acting on it to improve student outcomes is what really matters. Schools with regular student support meetings for at-risk students can track interventions like additional tutoring hours, attendance contracts or social skills groups. This is a building block to close the loop and monitor how effectively these interventions are serving students.

Interventions

It also allows capturing meeting notes as part of the student's record, which is particularly important on interdisciplinary teams.

Contributing

We'd love your help! Take a look at CONTRIBUTING.md for more information on ways educators, developers and others can get involved and contribute directly to the project. You can also learn how to join our online chat channel and submit pull requests and join us in person at our weekly hack night with Code for America, in Kendall Square, Cambridge.

How it works

The project is a Rails app with a Postgres database. There are background tasks that replicate data from the Aspen SIS system and STAR assessment system into the Postgres database. This enables rapid iteration and experimentation on new product features with minimal risk to these existing production systems. The Postgres database is the system of record for unique data captured by the Student Insights product (eg., notes from clinical meetings and information about targeted interventions that students are receiving). Authentication is handled by the district's LDAP service.

how it works

Admin dashboard

This project includes an admin dashboard built with thoughtbot/administrate.

The admin dashboard has one function: Allow admins (principals, assistant principals, district admins) to set user roles and permissions for other staff, in particular staff who are not classroom-based teachers.

The admin dashboard is available at /admin for educators whose admin attribute is true.

Development Environment

This is a Ruby on Rails app that uses a PostgreSQL database, and relies on React for much of the UI code.

1. Install dependencies

Choose your favorite local development approach:

2. Create database tables and seed them with demo data

bundle exec rake db:create db:migrate db:seed

This will create demo students with fake student information. The demo educator username is demo@example.com and the demo password is demo-password.

3. Start Rails

Once you've created the data, start a local server by running rails s from the root of your project. When the local server is up and running, visit http://localhost:3000/ and log in with your demo login information. You should see the roster view for your data.

4. Run the tests

This app uses Rspec. Run the test suite:

rspec

It uses Jasmine for JavaScript tests, run through the Teaspoon gem. You can run them in the browser at http://localhost:3000/teaspoon/default.

You can also run them from the command line:

teaspoon

eslint is setup, but not in the build yet since it would take some cleanup. See studentinsights#637 for more information, and try this out with either:

docker-compose build tools
docker-compose run tools

or

cd scripts/tools
npm install
npm run lint-quiet

5. Write code!

This project is a Rails app and has a typical Rails project structure. If you'd like to get up to speed on Rails, we recommend checking out their great documentation.

It also uses React for much the user interface code. If you'd like to get up to speed on React, we recommend their great documentation, and the Tutorial and Thinking in React pages in particular.

There are also a few places where we use Flux patterns.

If you use Sublime Text Editor, we include the studentinsights.sublime-project file to standardize minor things like tabs vs. spaces, indentation, and generally make it easier to work with our folder structure. Go to Project --> Open Project and select that file to load it. Sublime remembers which project you were last in, so you only need to do this once. (Here's some background info on how projects work in Sublime).

Browser/OS Targeting

Category Target Comment
Browser IE 11 "Should be all IE 11 by now."
– John Breslin, Technology Department, Somerville Public Schools
OS Windows 7 and 8.1 "Maybe some Win10 next year."
– John Breslin, Technology Department, Somerville Public Schools

Deployment

Deploying new code to Insights

See our guide:

Merging and deploying new code to Heroku.

Setting up Insights for a new district

New district script

Insights uses a separate-instance strategy for new districts (one database and one Heroku app per district).

Set up a new district:

$ scripts/deploy/new_district.sh "My New District Name"

This sets up a new Heroku app instance with the Student Insights code and copies over some basic configuration around the district name. It gives you the option to fill the instance with fake data if you like. It doesn't yet include tooling for connecting with a Student Information System or other district-level data sources.

Importing real data

If you're working with a real school district, you'll need flat files of the data you want to import.

Run an import task:

thor import:start

So far, Student Insights can import CSV and JSON and can fetch data from AWS and SFTP. To import a new flat file type, write a new data transformer: app/importers/data_transformers. To import from a new storage location, write a new client: app/importers/clients.

LDAP

The project is configured to use LDAP as its authentication strategy in production. To use database authentication (in a production demo site, for example) set the SHOULD_USE_LDAP environment variable. Authentication strategies are defined in educator.rb.

Heroku notes

Quotaguard Static, a Heroku add-on, provides the static IP addresses needed to connect with Somerville's LDAP server behind a firewall. This requires additional configuration to prevent Quotaguard Static from interfering with the connection between application and database.

One way to accomplish this is to set a QUOTAGUARDSTATIC_MASK environment variable that routes only outbound traffic to certain IP subnets using the static IPs. Read Quotaguard Static's documentation for more information.

Other Tools

Mixpanel

We use Mixpanel to track user interactions on the client side. It gives us nice graphs so we can see who's using the app and how.

More information