Giter VIP home page Giter VIP logo

fitlit's Introduction

๐Ÿƒ FitLit Project ๐Ÿƒ


Abstract

FitLit is an application that tracks and displays fitness data in an easy to read, dynamic, user dashboard. This project showcases the ability to get/fetch/post information to/from an API, and display it in a stylish, easy to use UI.


Contributors


Tech Used

  • Javascript
  • CSS
  • HTML
  • Object Oriented Programming
  • Git/GitHub
  • Webpack
  • Mocha/Chai
  • Chart.js
  • Lighthouse

Installation/Set-Up

  • Click this link to view the gitHub repository.

  • To view code on the text editor of your choice (I used atom to construct this code):

  • First: Clone this repositoryin your terminal by entering git clone https://github.com/turingschool-examples/fitlit-api and then cd fitlit/api. Run npm install to download all necessary packages and dependencies. Finally, run npm start to run the server.

  • Second: Clone this repository in your terminal by entering git clone https://github.com/maddielaw/FitLit and then cd FitLit. Run npm install to download all necessary packages and dependencies. Finally, run npm start and copy and paste the URL that is provided next to the "Your Project is Running at" statement.


How To Use FitLit

Currently, the FitLit Dashboard displays all information for a random user in our API databases, initiated on page load. The user information is separated into the following sections: user profile, friends list, activity data, hydration data, and sleep data.

chart

User Profile:

The user profile is located in the top right hand corner, and contains the following:

  • User's full name
  • Email address
  • Stride Length
  • Daily Step Goal
  • A comparison chart between the user's step goal and the average step goal of the FitLit community:
  • A button to navigate to the form submission page, upon which users can enter new stats for sleep, hydration, and activity data.

Data Submission Page

Upon clicking the Log today's stats button in the user profile section, users will be directed to a page that contains forms for submitting Activity, Hydration, or Sleep data. Once all inputs are filled for a specific, the user may submit their new data, which is then POSTed to the locally hosted API. The user can then navigate back to the main page, which will reflect their newly posted data for the current date.

chart2

Friendlist

The friendlist is located in the bottom right hand corner, and contains the following:

  • A list of all of the current user's friends by name.

Hydration Data

Two widgets are used to represent hydration data:

  • One widget contains the number of fluid ounces consumed on the current day
  • One widget contains the data for how many ounces of water are consumed over a 7 day period.

Sleep Data

Two widgets are used to represent sleep data:

  • One widget contains the hours slept, sleep quality, average sleep hours, and average sleep quality for the current date.
  • One widget contains the data for sleep hours and quality over a 7 day period.

Activity Data

Two widgets are sued to represent activity data:

  • One widget contains the number of steps, minutes active, and miles walked for the current date.
  • One widget contains the data for all of the activity stats over a 7 day period.

Features

  • Fetching and displaying data from an API
  • POSTing new information to the corresponding APIs via form input

Future Additions

The current live project represents the completion of part I and II of a Turing School of Software and Design Module 2 ongoing project.

In the future, we plan to:

  • Add icons for all of the widgets
  • Add a user icon or photo for the current user and friends
  • Continue to refactor the scripts.js file to separate DOM updates into the domUpdates object, located in the domUpdates.js file
  • Design a step challenge between friends
  • Implement day.js
  • Responsive design

Credits

fitlit's People

Contributors

lwatz16 avatar nvalentini21 avatar maddielaw avatar robbiejaeger avatar hannahhch avatar niksseif avatar brittanydionigi avatar khalidwilliams avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.