Create README.md for the FitSplit Website

[godisblaack]

Create README.md for the FitSplit Website

Description:
We need to create a detailed and user-friendly README.md file for the FitSplit Website project. The README will serve as a guide for users and developers to understand how to use the website, the workout plan structure, installation instructions, and how to contribute.

---

Acceptance Criteria:

1. Branch Creation:

   • Create a new branch from the main branch. Name it create-readme.

     git checkout -b create-readme

2. README.md File Content:

   • The README.md file must include the following sections:

   Project Overview:

   • A brief introduction to the FitSplit Website and what it does.

   Features:

   • Experience Levels: Explain the three experience levels (Beginner, Intermediate, Advanced).
   • Customizable Schedule: Explain that users can choose how many days they want to work out per week (1-7).
   • Workout Plans: Mention the 21 workout paths based on experience level and workout frequency.
   • Workout Videos: Mention that each workout plan includes instructional videos showing the correct form.

   Available Workout Plans:

   • List the available workout plans, including the frequency (1-7 days) for each experience level (Beginner, Intermediate, and Advanced).

   How to Use:

   • Provide detailed steps on how users can select their experience level, pick a workout schedule, and view the workout plan with videos.

   Technologies Used:

   • Frontend: HTML, CSS, JavaScript
   • Video Hosting: YouTube (for hosting workout videos).

   Installation:

   • Provide instructions on how to clone the repository, navigate to the project directory, and run the website:

     1. Clone the repository:

        git clone https://github.com/godisblaack/FitSplit.git

     2. Navigate into the project directory:

        cd FitSplit

     3. Running the website:

        • Open the project in your preferred IDE (e.g., Visual Studio Code).
        • Use the Live Server extension (by Ritwick Dey) to run the website locally. Search for ritwickdey.LiveServer in the extensions marketplace.

   Contributing:

   • Explain how to contribute to the project, including forking the repository, creating a new branch, making changes, and submitting a pull request.

   License:

   • Include a section about licensing, specifying that the project is under the MIT License.

---

Steps to Complete:

1. Create Branch:
   Create a new branch create-readme from main:

   git checkout -b create-readme

2. Create the README.md:
   Add the provided content to the README.md file in the project’s root directory.

3. Push the Changes:
   After adding the content, commit the changes to the new branch:

   git add README.md
   git commit -m "Added README file for FitSplit website"
   git push origin create-readme

4. Create a Pull Request:
   Open a pull request (PR) from the create-readme branch to main.

---

Priority: High

Estimated Time: 1-2 hours

---

Notes:

• Double-check the folder structure when running the website locally; if needed, adjust the directory names accordingly.
• Make sure to follow the formatting rules in the README, such as using headers and bullet points for readability.
• Confirm that all external links (e.g., the GitHub repository and video hosting) are working and valid.

---

Use the following content in the README.md file.

---

FitSplit Website

Welcome to the FitSplit Website, where users can select their workout experience level (Beginner, Intermediate, or Advanced) and customize their workout schedule based on the number of days they want to work out each week (1-7 days). The site offers 21 unique workout plans with a video demonstrating the correct form for each exercise.

Features

• Experience Levels: Choose from Beginner, Intermediate, or Advanced workout plans.
• Customizable Schedule: Select how many days you want to work out per week (1-7 days).
• Workout Plans: 21 possible workout paths based on experience level and workout frequency.
• Workout Videos: Each workout plan comes with a video that shows the proper form for each exercise.

Available Workout Plans

The website offers a total of 21 different workout paths:

• Beginner Plans:

  • 1 day/week
  • 2 days/week
  • 3 days/week
  • 4 days/week
  • 5 days/week
  • 6 days/week
  • 7 days/week

• Intermediate Plans:

  • 1 day/week
  • 2 days/week
  • 3 days/week
  • 4 days/week
  • 5 days/week
  • 6 days/week
  • 7 days/week

• Advanced Plans:

  • 1 day/week
  • 2 days/week
  • 3 days/week
  • 4 days/week
  • 5 days/week
  • 6 days/week
  • 7 days/week

Each of these workout plans includes:

1. Warm-up: A dynamic stretching routine to prepare the body for the workout.
2. Main Workout: A series of exercises tailored to the selected experience level.
3. Cool-down: Stretching exercises to help recovery.
4. Important Considerations: Careful considerations about the workout.

How to Use

1. Visit the Homepage: Click the start button, then choose your experience level (Beginner, Intermediate, or Advanced).
2. Select Days Per Week: Pick the number of days you want to work out (1-7).
3. Workout Plan: Once you’ve made your selections, you’ll be shown a workout plan that matches your preferences.
4. Follow Along: Each exercise includes a video showing the correct form, ensuring you perform each move safely and effectively.

Technologies Used

• Frontend: HTML, CSS, JavaScript
• Video Hosting: YouTube for hosting workout videos.

Installation

1. Clone the repository:

   git clone https://github.com/godisblaack/FitSplit.git

2. Navigate into the project directory:

   cd workout-plan-website

3. Running the website:
   Open the site in your browser using the Live server extension by Ritwick Dey. Search the extension by the extension ID ritwickdey.LiveServer.

Contributing

We welcome contributions! If you have any suggestions or bug fixes, feel free to fork the repository, create a pull request, and we'll review it.

Steps to Contribute:

1. Fork the repo
2. Create a new branch (git checkout -b feature/your-feature)
3. Make your changes
4. Commit your changes (git commit -m "Add feature")
5. Push to the branch (git push origin feature/your-feature)
6. Create a pull request with a detailed description of your changes.

License

This project is licensed under the Unlicense license.