We will be holding weekly office hours on moocRP every Wednesday in April (Starting April 1st) at 9:30-10:30am PDT. Join us:
Research platform for University of California, Berkeley researchers built by Kevin Kao in collaboration with Professor Zachary Pardos. See our Learning@Scale ACM publication for more information: http://dl.acm.org/citation.cfm?id=2724683
To contribute to this project, please fork the project and make pull requests, or create Github issues.
Built on Node.js server with Sails.js framework for an MVC architecture. Python/Bash scripts and D3 visualizations mixed in.
Releases will be numbered as < major version >.< minor version >.< patch number >
The current release version is: 0.1.5
Last update: 3/11/15
Kevin Kao
- Installation
- Configuration
- Deployment
- Tests
- Analytic Module Instructions
- Data Models
- Data Distribution
- edX Data Scrubbing
- Changelog
- Features
- Bugs
- Roadmap
- License
Before deployment, you must read the configuration documentation. The local.js file must be added to the configuration before moocRP will launch correctly. Ensure that the port and database settings are correct.
To run the application in production continuously, we use the pm2 package (install it through sudo npm install pm2 -g). See more optimization settings for launching using pm2 here. We provide the basic launch scripts below.
Run this script to start the server:
./bin/run_moocRP.sh
To stop the server, run:
./bin/stop_moocRP.sh
To test the moocRP application, please make sure all configurations above are in place. Then, run:
redis-server
npm test
0.1.5 - 12/29/2014: Download functionality added in additional updates, refactoring of analytic schemas (past 0.1.4 release).
0.1.4 - 12/28/2014: Patch to add functionality to contact/report form, better linkage of data models and requests, as well as folders on disk. Initial test suite implemented in. Data model modifications and security checks added.
0.1.3 - 10/18/2014: Patch to update start up and setup scripts. Fixed bug that deleted the wrong entries in requests/analytics tables. Added search/description features to analytics. Changed data type support to data model support. Fixed minor bugs with registration; removed launch from production minification to prevent bugs in UI.
0.1.2 - 09/08/2014: Patch for update on completion of moocRP analytics module specifications and import abilities. Dependency of Sails supported up to 0.10.5.
0.1.1 - 08/14/2014: Patch to add support for future additions of datascrub types. UI browser compatibility updates, refactored database models to be more efficient.
0.1.0 - 08/11/2014: First minor version release.
0.0.3 - 07/01/2014: First version with working request/download system, visualization upload system, user management UI.
0.0.2a - 03/04/2014: Alpha version that replaced login system with Berkeley's CAS authentication.
0.0.1a - 02/01/2014: Alpha version with working login/verification system.
- SSL integration
- Node.js CAS client (login system)
- Simple data distribution system (dataset request and download system)
- Generalized analytics/visualizations sharing platform
- Administration controls
- Sleek, responsive UI
- GPG encryption system for dataset downloads
- Support for multiple data models, from edX to Coursera, the HarvardX tools to raw data
- Multi-file support for multiple flat files per data model
- When deploying in production, moocRP must be deployed once first in development mode so that the database tables are created - find a way to automate this.
- [P] Add "Reports" messaging system for managing bug handling/error messages
- Integrate JIRA ticketing system for open source release and collaboration
- Add support for hooking datasets to the visualization upload system
- Strip out CAS client to package into npm package
- Add profile updates for users
- Add support for sharing research papers
- Add support for running pre-processing scripts on datasets before visualizing (i.e. machine learning code)
- Add multi-file support for each data model
- [P] Convert to using pub/sub and piping system for large datasets
- Investigate and implement automatic code review security
- Begin populating Github wiki for instructions on use
- Perform penetration testing and security checks
- Scale/stress testing + test suites need to be developed
- Add features to star/"bookmark" visualizations
- Implement alternative login system for non-CAS institutions
MIT