FITFLEX

About FITFLEX
Tech Stack
What can you contribute?
How to contribute?
How to make a pull request?
Project Contributors
License

📌 Open Source Program

This project is now OFFICIALLY accepted for

About FITFLEX

FitFlex is a fitness and weight loss website that offers daily, structured workout plans for a set period. Users can follow day-wise exercises tailored to their goals, whether it’s for weight loss, muscle gain, or general fitness. FitFlex provides a simple, user-friendly interface to help track progress and stay consistent throughout the fitness journey.

We also have a Discord server to discuss doubts and suggestions! Make sure to join it here:

Tech-Stack

What can you contribute?

Find All the details in CONTRIBUTING.md before contributing
Please follow guidelines in Code_of_Conduct.md

How to contribute?

Drop a Star in this repo
Take a look at the existing Issues.
Fork the Repo create a branch for any issue that you are working on and commit your work.
At first raise an issue in which you want to work
Please do not make more than 2 issues at a time , Once your PR have been merged only then go for the next issue
Then when you are get assigned only then work on that issue & make a PR
Please try to make a separate branch in your fork in case of PR
Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
REMINDER: Commit inside the Projects Folder
Find the already Existing Projects in the Projects Folder
Add screenshots or video prototypes to your Pull Request to help us understand the effects of the changes that are included in your commits.

Installation and Setup

Prerequisites

Node.js
npm

Steps

Clone the repository:

git clone https://github.com/Open-Code-Crafters/FitFlex.git

Navigate to the project directory:
```
cd FitFlex
```
Install Dependencies:
```
npm install
```
Run the project:
```
npm run dev
```
Contribution Guidelines Move detailed steps to a new CONTRIBUTING.md file and link to it:

Steps using Docker

Clone the repository:

git clone https://github.com/Open-Code-Crafters/FitFlex.git

Navigate to the project directory:
```
cd FitFlex
```
Install Docker Image:
```
docker build -t my-app .
```
Run Docker Image:
```
docker run -p 5173:5173 my-app
```
Steps to get Docker Desktop for running the application using docker Go to "https://www.docker.com/products/docker-desktop/" and download Docker Desktop for Mac/Windows/Linux

How to make a Pull Request?

1. Start by forking the FITFLEX repository. Click on the symbol at the top right corner.

2. Clone your forked repository:

git clone https://github.com/<your-github-username>/FitFlex

3. Navigate to the new project directory:

cd FitFlex

4. Set upstream command:

git remote add upstream https://github.com/Open-Code-Crafters/FitFlex

5. Create a new branch:

git checkout -b YourBranchName

git branch YourBranchName
git switch YourBranchName

6. Sync your fork or local repository with the origin repository:

In your forked repository click on Fetch upstream.
Click Fetch and merge.

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream

git merge upstream/main

Github Docs for Syncing

Read the documentation

7. Make your changes to the source code.

8. Stage your changes and commit:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

git add file/folder

git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

Congratulations! You've made your first contribution! 🙌🏼

Project Contributors

License

Show some ❤️ by giving to this repo

Open-Code-Crafters/FitFlex