SparrowFit is a web based application that allows a user to create workout plans and use their created templates during their workout with a timer to help through each exercise.
This will guide you through installing and opening the app, creating a workout and starting the workout assistant tool.
First, run npm install from the root directory of this repository.
This will install all requirements needed to run the core program.
note: There is a package.json and bower.json in the src folder. Running npm install in the root directory will trigger a post install that will install all dependencies.
Next, run npm start, which will start the server on localhost:3002
Our authentication system uses Auth0. Sign up for an account with Auth0 and create a client with which you will have access to a clientID (Auth0's way of idenfiying you) and domain. These will have to be added to the .env file as environment variables.
You can list the callback url in your Auth0 settings.
Checkout the .env.example file and fill in the following sections to get it running.
DOMAIN =
CLIENT_ID =
AUDIENCE =
SECRET =
Note: DOMAIN and CLIENT_ID are passed from server to client via get request in src/app.js.
After logging in, a new bar should display in the top left corner.
Click on Create Workout and then Create Timed Workout to get to the Create Workout Component page.
The Create Workout Component page has two section. Fill out the Template Name to name your workout, Then, you can add individual exercises by filling out a name, duration and the a break time between exercises.
Ex. Name: Pushups, Duration: 1 minute 30 seconds, Break: 45 would be one exercise of a Workout.
Click the Add Exercise button to add an exercise to the workout template.
Once you have all of the exercises you want in the template, click the Add Template button.
From here, click on the Workout tab to the right of Create Workout.
On the Workout page, select a previously created template by either typing its name into the text field
or by clicking on Timed or Untimed Workout buttons and clicking on a workout the button displays.
This will display the details of the workout. Click the Add Data to Timer button to create a timer.
Lastly, click Start to begin the timer which will run through the created workout.
SparrowFit is built using the MEAN stack along with some help for Auth0, FlipClock.JS and Bootstrap.
SparrowFit's Mongo Database uses Mongoose as an orm. It's code is built in the db folder containing two files.
First, mongoose-schemas.js creates schemas for four different Database tables.
User stores information on individual users to the app. Template stores the workouts that are created a user. History stores the previous activity of a user. Goals stores information on goals the user sets for themselves.
/db also contains seed.js which clears and adds fake data to the database when run.
Running node db/seed.js will drop and repopulate the database.
We have used mLab for our cloud database system.
Checkout .env.example and fill in the following sections to get it running.
MONGO_SERVER =
MONGO_USERNAME =
MONGO_PASSWORD =
The server's code is stored in /server/index.js, which creates an Express server to serve up the client-side code, check that a user is logged in, and make database queries when endpoints are reached.
The code in this file will show all of the possible GET and POST requests that can be made to the server and is where new ones can be added.
We are using morgan express middleware in server/index.js to log all incoming requests to the server. It logs the req.method, endpoint and a timestamp in your terminal.
Lastly, the src folder handles the client side code, containing the necessary dependencies, html, css and relevant javascript.
Along with more modularized folders, /src contains index.html, which is the main html file which the client will be loaded into, and which will load app.js to help with state-based routing. The other folders contain specific code for the different sections of the app to be loaded, most of which are contaiined inside of /src/client.
Inside of /src/client, /components contains the different aspects for the program, creating the view and code to create workouts, goals, and load and navigating through a workout. Each of these is taken care in its corresponding folder.
The other folder inside of client is services, which contains Angular services used throughout the program.