Epilepsy Portal

About

The Epilepsy portal is de-identified patient and survey management system. It allows clinicians to view the response collected through mobile application. As well as allowing clinicians to monitor patient responses to look for possible interventions.

Installation Instructions

1. install Git
2. install Node JS
3. install MySql
4. optionally install Node Gyp dependencies (strongly recommended)
5. clone git repository https://github.com/promisasu/BrainTracker_Portal.git
6. open the folder cd Portal
7. run npm install

Setup Instructions

1. if you do not already have a database user, create one
2. create a new empty database CREATE SCHEMA epilepsy_development;
3. run npm run init
4. run npm run seed

Start the Portal

1. run npm run start

Debug the Portal

• run npm run status to view status of all servers
• run npm run log to view server logs

Test the Portal

1. run npm run lint
2. run npm run test

View Code Documentation

1. run npm run documentation
2. open the documentation folder in a file explorer
3. open index.html in a browser

Additional Guides

• Contributing
• Design
• Issue Template
• Pull Request Template

Tasks

Tasks can be run by calling npm run <task>

• check detect outdated or insecure packages
• documentation generate code documentation
• init create a server configuration file
• lint lint check project files
• lint-fix auto fixes some lint errors
• log view server logs
• seed fill database with sample data
• start start all services
• start-dashboard start dashboard service
• start-scheduler start scheduler service
• status check service statuses
• stop stop all services
• stop-dashboard stop dashboard service
• stop-scheduler stop scheduler service
• sync synchronize database schema
• test run the test suite
• user create a new user
• validate detect invalid server configuration