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

Commit

Permalink
adding readme directions and minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nitrotap committed May 16, 2023
1 parent 27dfe29 commit 6152422
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 2 deletions.
Binary file added .DS_Store
Binary file not shown.
76 changes: 75 additions & 1 deletion README.md
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.

![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)
![badmath](https://img.shields.io/github/stars/nitrotap/brain-lift)

## 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>&copy; 2023 Kartik Jevaji. All rights reserved.</p>
3 changes: 2 additions & 1 deletion client/angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@
"cli": {
"schematicCollections": [
"@ionic/angular-toolkit"
]
],
"analytics": false
},
"schematics": {
"@ionic/angular-toolkit:component": {
Expand Down

0 comments on commit 6152422

Please sign in to comment.