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.
Check out the demo site with different roles:
- District admin:
- K8 principal:
- Kindergarten teacher:
- HS physics teacher:
- 9th grade counselor:
All accounts use the 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
- Product overview: How we're helping
- How it works
- Development Environment
- Browser/OS Targeting
- Deploying new code to Insights
- Setting up Insights for a new district
- New Heroku instance
- New SFTP Site
- Importing data
- Heroku notes
- Data differences between districts
- Feature differences between districts
- More information
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
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).
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.
Data can be exported as a CSV for more sophisticated analysis.
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.
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.
Student profiles also contain the full case history of demographic information, attendance and behavioral support.
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.
It also allows capturing meeting notes as part of the student's record, which is particularly important on interdisciplinary teams.
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.
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
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
You'll need Ruby, Postgres and yarn. See our local installation on OSX or Linux guide.
$ bundle install $ yarn install
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. See the demo site above for the set of educators you can use (or look at
If you are willing to run a longer (~10 minute) task that will generate ~600 students to more closely approximate one of our pilot schools, set
ENV["MORE_DEMO_STUDENTS"] = 'true' before running the seed task.
3. Start the app
Once you've created the data, start the app by running
command+c like normal, and look at
package.json if you want to run them in individual terminals.
4. Run the tests
For Ruby code, to lint and run the tests do:
For Jest, run the tests continually in watch mode with:
rubocop yarn lint
If you miss something, tests will run on any pull request you submit, and after merging to master as well.
5. Write code!
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).
We also recommend Sublime Package Control and these packages Babel, Sublime Linter and SublimeLinter-contrib-eslint. These will give you nice syntax highlighting and show you linter errors right in Sublime!
6. Use the product locally
Users use IE11, so if you're trying to manually test locally or the production site, you should too! If you have a Mac or Linux box, you can use free VMs designed for just this purpose and run them on VirtualBox: https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/.
- Visit get.adobe.com/reader in the VM to install a PDF reader
- These virtual machines expire after 90 days, so take a snapshot right away and rollback when it expires (make sure to log out of Insights before taking a Snapshot, and that no student report PDFs are lying around in the VM's downloads)
- Enable "Shared Clipboard" in the Devices menu
- Disable the "Host Capture" key
- Point to http://10.0.2.2:3000/ to access the host instance of Student Insights
- Use Storybook
yarn storybookwill start a storybook server on port 6006. You can use this to create "stories" iterate on UI features or components in particular states, separate from how they exist within the product. To add new stories, write a new
.story.jsfile and update
|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
Deploying new code to Insights
See our guide:
Creating a new Insights instance
Quotaguard Static, a Heroku add-on, provides the static IP addresses needed to connect with district LDAP servers which are firewalled. The
QUOTAGUARDSTATIC_MASK environment variable is a subnet mask for routing only certain outbound requests through the static IPs. Read Quotaguard Static's documentation for more information.
Data differences between districts
|District||Data Source||Data Import Notes|
|Somerville||Aspen SIS||Somerville IT runs the SQL scripts in the x2_export folder every night to create CSVs and dump them to an SFTP site. We import the CSVs to Insights nightly.|
|Somerville||STAR (assessment vendor)||STAR IT team runs a job when Somerville STAR assessment results come in that dumps fresh CSV data to an SFTP site. We import the CSVs to Insights nightly.|
|Somerville||EasyIEP||EasyIEP runs "change export" of IEP PDFs that have changed and sends them to an SFTP nightly. Somerville IT runs a job to copy those files into Aspen and another job to copy those files to an Insights SFTP site. We import the PDFs to Insights nightly.|
Feature differences between districts
|District||Feature Area||Feature Notes|
|Somerville||School Overview Page||Somerville High School Housemasters are requesting a feature that will let them sort students by House. (More info on houses here.)|
Here are some notes on maintaining, troubleshooting and performance.
Look in the Heroku metrics panel.
You can use heroku-pg-extras to get helpful diagnostic information about slow queries, index usage, and table scans.