kristiannmiller / km-jw-fitlit

FitLit project starter kit for students

Fitlit

Exploring array iterator methods, dynamically displaying data on the DOM, and using TDD.
Explore the docs

Table of Contents

• About the Project
  • Built With
  • Installation
• Usage
• Contributing
• Contact
• Acknowledgements

About The Project

This project is part of Turing Software and Design's Front-End Program, Module 2. The project focused on building an application using test-driven-development (TDD) every step of the way. The program was implemented with ES6 syntax and exclusively uses array-prototype methods whenever iterations need to be performed. There are no for loops used in the program. Four distince databases were originally supplied, each representing large chunks of data for 50 randomly generated "users". Our task was to create several objects containing methods which would dynamically display a given users' data on the DOM when selected.

Built With

• Node.js
• Mocha
• Chai

Installation

1. Clone the repo git clone https://github.com/Kristiannmiller/km-jw-fitlit.git

2. Install NPM packages Mocha Chai Moment.js Chart.js

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Roadmap

The total allotted time for this project was approximately 10 days. Future features contemplated by the developers included the following:

• More fully responsive DOM;
• Methods to compare a user's friends' (team) daily stats against another user's friends' stats;
• Update the data being used with apis and porting the information to a remote server;

See the open issues for a list of proposed features (and known issues).

Contact

Kristi Miller - email

Jeff Woltjen - [email protected]

Project Link: https://github.com/Kristiannmiller/km-jw-fitlit

Acknowledgements

Robert Gu - The developer team would like to thank Turing Module 2 anchor instructor Robert Gu for helping unlock the mysteries and potential of his favorite coding language, Javascript.

Travis Rollins - We would also like to thank Turing Module 2 instructor Travis Rollins for his guidance and assistance during this project and the module in general.

km-jw-fitlit's Issues

Sprint1 :: user properties

Each user holds on to the user properties from the data file

Test issue

As a developer, when I visit issues in GitHub, I want to see an issue, so that I can address the issue

Sprint3 :: sleep quality each day per week

For a user, their sleep quality each day over the course of a given week (7 days) - you should be able to calculate this for any week, not just the latest week

Possible Solution

filter method

Sprint2 :: Create water intake for day

A display to show how much water they have consumed today (these displays are often called “widgets” in the FE tech world)

Sprint1 :: User class

Build functionality to class where User represents a single user

Sprint4 :: add to team stats - activity leaderboards

How their number of

• steps
• minutes active
• flights of stairs climbed

compares to all users for the latest day

Sprint3 :: hrs slept each day per week

For a user, how many hours slept each day over the course of a given week (7 days) - you should be able to calculate this for any week, not just the latest week

Possible Solution

filter method

Sprint3 :: Sleep quality/day

For a user, their average sleep quality per day over all time

Possible Solution

reduce method

Sprint3 :: Average sleep quality for user

For all users, the average sleep quality

Possible Solution

reduce method

Sprint1 :: data

Build functionality to take in user data

Sprint4 :: Add to dash - steps/day

For a user, the number of steps for the latest day

Sprint3 :: add sleep data/week to dashboard

For a user, their sleep data over the course of the latest week (hours slept and quality of sleep)

Sprint2 :: Create water intake per week widget

A display to show much water they have consumed each day over the course of the latest week

Sprint3 :: Average hrs slept/day

For a user (identified by their userID), the average number of hours slept per day

Possible Solution

reduce method

Sprint1 :: UserRepository

Building functionality that holds all of the User objects in UserRepository

Sprint1 :: TDD

Create TDD testing to test functionality of UserRepository and User classes

Sprint2 :: fl oz per day

For a user, how many fluid ounces they consumed for a specific day (identified by a date)

Possible Solution

find method

Sprint4 :: add to dash - weekly activity stats

For a user, a weekly view of their step count, flights of stairs climbed, and minutes active

Sprint4 :: Step goal met

For a user, did they reach their step goal for a given day (specified by a date)?

Possible Solution

filter method

Sprint 1.5 :: CSS/HTML layout

Achieve minimal viable layout

STARTING POINT:

• static

POLISHED POINT:

• static
• mobile

BONUS POINT:

• static
• mobile

Sprint4 :: add to dash - miles/day

For a user, the distance they have walked (in miles) for the latest day based on their step count

Sprint4 :: miles per day

For a specific day (specified by a date), return the miles a user has walked based on their number of steps (use their strideLength to help calculate this)

Possible Solution

either map or reduce method(s)

Sprint1 :: User methods

Should have a method to return only the user's first name

Sprint1 :: UserRepository methods

Build methods within UserRepository class that:

• Given a user's ID, what is their user data?
• The average step goal amongst all users

Sprint4 :: average minutes active/week

For a user, how many minutes active did they average for a given week (7 days)?

Possible Solution

reduce method

Sprint1 :: scripts.js

Use the scripts.js file to add information to the DOM for one random user

Sprint4 :: Create an activity metric

Make a metric of your own! Document it, calculate it, and display it.
Return flights of stairs per day per user

Possible Solution

forEach method

Sprint4 :: All days step goal met

For a user, find all the days where they exceeded their step goal

Possible Solution

filter method

Sprint3 :: create a metric

Make a metric of your own! Document it, calculate it, and display it.
Greatest sleep of all time

Possible Solution

sort/unshift methods

Sprint3 :: add overall average sleep quality to dashboard

For a user, their all-time average sleep quality and all-time average number of hours slept

Sprint4 :: Greatest stair climbing record

For a user, find their all-time stair climbing record

Possible Solution

find/sort method(s)

Sprint3 :: add sleep data/day to dashboard

For a user, their sleep data for the latest day (hours slept and quality of sleep)

Sprint4 :: Team activity averages

For all users, what is the average number of:

• stairs climbed for a specified date
• steps taken for a specific date
• minutes active for a specific date

Possible Solution

forEach/reduce method(s)

Sprint2 :: Average fl oz overall

For a user (identified by their userID - this is the same for all methods requiring a specific user’s data), the average fluid ounces consumed per day for all time

Possible Solution

reduce method

Sprint3 :: Heaviest sleepers

For a given day (identified by the date), find the users who slept the most number of hours (one or more if they tied)

Possible Solution

find/sort method

Sprint1 :: Display first name

Display their first name somewhere prominently on the page to welcome them

Sprint1 :: Display info card

Create an info card on the dashboard with all of user’s info on the page

Sprint1 :: userData parameter

User class should have a parameter to take in a userData object

Sprint3 :: Sleep hours/day overall

For a user, how many hours they slept for a specific day (identified by a date)

Possible Solution

find method

Sprint1 :: Display step goal comparison

For a specific user, display how their step goal compares to the average step goal amongst all users (this display should not be hard-coded)

Sprint3 :: sleep quality average > 3

Find all users who average a sleep quality greater than 3 for a given week (7 days) - you should be able to calculate this for any week, not just the latest week

Possible Solution

filter/sort method

Sprint4 :: add to dash - min active/day

For a user, the number minutes active for the latest day

Sprint2 :: fl oz per week

For a user, how many fluid ounces of water consumed each day over the course of a week (7 days) - return the amount for each day

Possible Solution

filter method

Sprint4 :: active minutes

For a user, (identified by their userID) how many minutes were they active for a given day (specified by a date)?

Possible Solution

find method

Sprint3 :: Sleep quality for specific day

For a user, their sleep quality for a specific day (identified by a date)

Possible Solution

find method