This repository has been archived by the owner on Mar 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding readme directions and minor fixes
- Loading branch information
Showing
3 changed files
with
77 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,75 @@ | ||
# brain-lift | ||
# brain-lift | ||
|
||
## Description | ||
|
||
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. | ||
|
||
 | ||
 | ||
 | ||
 | ||
|
||
## Table of Contents | ||
|
||
- [Installation](#Installation) | ||
- [Usage](#Usage) | ||
|
||
- [Tests](#Tests) | ||
- [Questions](#Questions) | ||
- [License](#License) | ||
|
||
## Installation | ||
|
||
This application requires Node.js, Angular, and Ionic. | ||
|
||
### Visit the website to download and install Node.js. | ||
|
||
[https://nodejs.org/en/download](https://nodejs.org/en/download) | ||
|
||
### Angular CLI | ||
|
||
`npm install -g @angular/cli` | ||
|
||
### Ionic CLI | ||
|
||
`npm install -g @ionic/cli` | ||
|
||
### Clone the repo from GitHub | ||
|
||
`git clone https://github.com/nitrotap/brain-lift.git` | ||
|
||
### Use the develop branch | ||
|
||
`git checkout develop` | ||
|
||
### Install the npm packages | ||
|
||
Ionic Angular is set up in the client folder | ||
`cd client\` | ||
|
||
Install npm packages | ||
`npm i` | ||
|
||
### Run the development server | ||
|
||
`ionic serve` | ||
|
||
## Usage | ||
|
||
To launch development server, go to the client folder and run ionic serve | ||
|
||
`cd client` | ||
|
||
`ionic serve` | ||
|
||
## Tests | ||
|
||
`ng test` | ||
|
||
## Questions | ||
|
||
Please reach out to me on [GitHub](https://github.com/nitrotap) or by email at [email protected] for any additional questions. | ||
|
||
## License | ||
|
||
<p>© 2023 Kartik Jevaji. All rights reserved.</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters