/maxed-out

Primary LanguageJavaScriptMIT LicenseMIT

Maxed Out: a fitness tracker

made-with made-with
made-with made-with made-with made-with made-with GitHub issues GitHub branches GitHub contributors Github license

Description

A simple and easy to use at home fitness tracker where a user can log and view their workouts from the comfort of their own home. After a user logs in, they are taken to their personal workout dashboard, where they can see all workouts they have completed and add new ones.

Link to Deployed Application: https://aqueous-headland-83808.herokuapp.com/

Table of Contents

Installation

To use this application, please run and install:

  • npm init
  • npm install

This application uses bcrypt, bulma, connect-session-sequelize, dotenv, express, express-handlebars, express-session, mysql2, and sequelize. All of these should be listed under your dependencies in the package.json.

Usage

After cloning this repository to your local device and installing the packages listed above, first create a .env file in the root of the folder and add this code to the file:

  • DB_NAME='workout_tracker_db'
  • DB_USER='< your SQL user >'
  • DB_PW='< your SQL password >'

Then, run the following commands in the root of your project:

  • mysql -u root -p (enter password when prompted)
  • source db/schema.sql
  • quit
  • npm start (run the application on your localhost:3001)

There are seed files located in this project. If you would like to use the seed files, simply type 'npm run seed' in the command line before starting the application.

Screenshot of Deployed Application

  • Homepage

Screen Shot 2022-02-06 at 9 27 51 PM

  • After logging in, users view their personal dashboard

Screen Shot 2022-02-06 at 9 38 23 PM

Contributing

There are no current guidelines for contribution.

Tests

No testing is currently required for this application.

Credits

This project was completed by a team of 4:

License

This project is licensed under the MIT license.

Questions

If you have any questions about this project, please contact Jessica Hille directly at jessicalhille@gmail.com. You can view more projects created by the members of this team by checking out their GitHub pages, linked above.