Skip to content

394-win22/Fountain

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

258 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fountain

fountain-logo

Fountain is a fitness app that lets you do a quick workout of the day anywhere for fun and share with anyone

made-with-react Maintenance Documentation

Table of contents

How to download and install

To download the app, navigate to the folder where to wish to download the app to and run:

git clone https://github.com/394-win22/Fountain

In the project directory, you can run:

npm i

Installs all of the necessary libraries to run the app in development mode.
This generates yout node_modules folder.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

firebase deploy

Deploys the app to the specified firebase project.

Libraries

Node.js Download Node

Run npm install [package_name] for a missing library

Known bugs and issues

Some images could match to a wrong workout
Some workouts do not have a corresponding gif

Non-coding steps

Prerequisites

Creating .env file under the main folder, and add your firebase SDK config under the following format:

REACT_APP_API_KEY = "YOUR-UNIQUE-CREDENTIALS"
REACT_APP_AUTH_DOMAIN = "YOUR-PROJECT-NAME.firebaseapp.com"
REACT_APP_PROJECT_ID = "YOUR-PROJECT-FIREBASE-PROJECT-ID"
REACT_APP_STORAGE_BUCKET = "YOUR-PROJECT-NAME.appspot.com"
REACT_APP_MESSAGING_SENDER_ID = "YOUR-PROJECT-SENDER-ID"
REACT_APP_APP_ID = "YOUR-PROJECT-APP-ID"
REACT_APP_MESUREMENT_ID = "YOUR-MESUREMENT_ID"

Upload the defaults file to the realtime database of your firebase project.

Add the Twilio Text Messaging extension to your Firebase console and set up your Twilio account.

Credits

Kelvin Forson
Conor Kotwasinski
Dong Yang

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6