trackYourWorkout

Track Your Workout

This is a single page application ("SPA") for keeping track of your workouts. I really enjoy working out and since COVID, it has been hard to keep track of the workouts on youtube. Although playlist are nice, I thought it would be cool to have a place to see all workouts for a particular date and/or time.
Live Site - Coming Soon · View Youtube Demo · Blog · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This application was built with a rails backend and Javascript frontend.

Built With

• Ruby-on-Rails
• postgresql
• byebug
• Javascript
• Love ❤️

Getting Started

To get the application started you must have ruby and postgresql installed on your computer. Checkout the ruby on rails getting-started-guide to learn how to install it on your device. If you need to install postgres check out the doumentation here.

Prerequisites

Other than the gems listed in this app's Gemfile, you will need to have Ruby and Rails installed on your local machine as well as the ability to install Ruby gems.

Before running your server, you will need to install the gems and add content to your database manually or you can use the seeds file:

To install the gems first cd into track_your_workout_backend and run the following:

bundle install

To run your migrations and update your db/schema.rb file to match the structure of the database, run the following:

rails db:create

rails db:migrate

To create data in the database, run the following:

rails db:seed

rails s

and then go to your favorite browser and visit this webpage "http://localhost:3000/api/v1/workouts"

Installation

1. Clone the repo

git clone git@github.com:SincerelyBrittany/trackYourWorkout.git

3. Cd into backend and install the gemfile packages

bundle install

4. Run rails s
5. cd into frontend and open index.html

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Connect/Follow me:

Acknowledgements

• Youtube
• Google
• Flatiron School