diff --git a/README.md b/README.md index 35bc11d..e237cb9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Brain Lift helps users understand how their cognitive load affects their learning and performance. Use the NASA Task Load Index to measure and track your cognitive load for different tasks. +Brain Lift uses a PHP server for cost-effective and customizable server-side operations. User data is stored in a secure and reliable MySQL database. The front-end is built with Angular and Ionic, ensuring a responsive and intuitive user interface. These technologies together enhance the user's experience in tracking cognitive load. + ![badmath](https://img.shields.io/github/languages/top/nitrotap/brain-lift) ![badmath](https://img.shields.io/github/issues/nitrotap/brain-lift) ![badmath](https://img.shields.io/github/forks/nitrotap/brain-lift) @@ -54,6 +56,12 @@ Install npm packages `ionic serve` +### Set up database + +Be sure to set up and start the mysql database. Ensure the proper attributes are present in the env.php file. A sample is given in sample.env.php. + +In phpmyadmin, run tables.sql to set up the database. Run seeds.sql to add sample data to the database. + ## Usage To launch development server, go to the client folder and run ionic serve