Skip to content

Latest commit

 

History

History
59 lines (48 loc) · 2.7 KB

README.md

File metadata and controls

59 lines (48 loc) · 2.7 KB

Health Tracker

Health web application powered by Nutritionix API that helps track your daily calorie and fat intake. A demo can be found here. Features include:

  • Food search
  • Persistent data
  • API Error handling
  • Responsive layout
  • Jasmine test suit
  • JSDoc documentation

Table of Contents

Installation and Run

Demo: https://brianquach.github.io/health-tracker/dist/index.html

Grab code source:

  • Clone repository: git clone https://github.com/brianquach/health-tracker.git or download the zip here.
  • Navigate to the directory where you cloned the repo or unzipped the file to and open folder dist.
  • Use your favorite browser to open index.html.

Build Process

This project was built with the aid of Bower, NPM, Sass, and Gulp.

To grab the required 3rd-party frameworks, follow the instructions:

  • Install Bower.
  • Navigate to project's root folder.
  • Run bower install
  • Frameworks should be under ./bower_components

To run project's build process, follow the following instructions:

  • Install NPM.
  • Install Gulp.
  • Navigate to project's root folder.
  • Run npm install to let NPM install required Gulp plugins.
  • Run gulp optimize.

####Gulp Task Overview:

  • gulp default: watches JS, CSS, and SCSS to trigger the build task.
  • gulp build: compiles SASS, minifies JS and CSS, and moves assets to dist.
  • gulp doc: runs JSDocs to generate code documentation (docs\gen).
  • gulp test: runs Jasmine test suite.

Documentation and Test Suite

Code is documented using JSDocs and tested using Jasmine. See docs\gen\index.html to learn more about the code base and structure. To execute unit tests, run gulp test and navigate to localhost:8888.

Creator

Brian Quach

Copyright and License

Code copyright 2017 Brian Quach. Code released under the MIT license.