Skip to content
This repository has been archived by the owner on Mar 10, 2024. It is now read-only.

Commit

Permalink
adding readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nitrotap committed May 30, 2023
1 parent 71ba705 commit 4fa8941
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 4fa8941

Please sign in to comment.