Skip to content

Latest commit

 

History

History
183 lines (147 loc) · 5.14 KB

README.md

File metadata and controls

183 lines (147 loc) · 5.14 KB

Fit-Track

Welcome to Fit-Track, your go-to exercise log-tracking application built with the MERN (MongoDB, Express, React+Vite) stack with Bootstrap CSS Framework. This guide will help you get started with contributing to our project.

Tech Stack

Frontend
Backend
CI/CD

Table of Contents

Installation

Frontend

  1. Navigate to the frontend directory: 
    cd frontend
  2. Install the dependencies: 
    npm install
  3. Start the development server: 
    npm run dev

Backend

  1. Navigate to the backend directory: 
    cd backend
  2. Install the dependencies: 
    npm install
  3. Setup MongoDB Atlas:
    1. Go to MongoDB Atlas and create an account if you don't already have one.
    2. Create a new cluster by following the prompts. Mongo Atlas Cluster Creation Tutorial
    3. Once the cluster is created, go to the Database Access section and create a user with the necessary privileges.
    4. Go to Network Access and allow your IP address (or allow access from anywhere if testing locally).
    5. In the Clusters section, click Connect, then choose Connect your application. You'll see a connection string that looks like this: 
      mongodb+srv://<username>:<password>@cluster0.mongodb.net/?retryWrites=true&w=majority
    6. Replace <username> and <password> with your actual MongoDB Atlas username and password. Copy the entire connection string.
  4. Add MongoDB ATLAS_URI to .env file:
    • Create a .env file in the backend directory.
    • Add the following line to the .env file, replacing <your-mongodb-connection-string> with the connection string you copied from MongoDB Atlas: 
      ATLAS_URI=mongodb+srv://<username>:<password>@cluster0.mongodb.net/fit-track?retryWrites=true&w=majority
  5. Start the server: 
    node server.js
    or if nodemon is installed for live updates of backend: 
    nodemon server.js

Project Structure

Frontend

The frontend directory contains the React application.

frontend/
├── public/
├── src/
├───assets/
│   └───lottie
├───components/
│   ├───common/
│   ├───Exercise/
│   ├───Heatmap/
│   └───Navbar/
├───pages/
├───slices/
├───store/
└───utils/

Backend

The backend directory contains the Node.js server and Express application.

backend/
├── models/
├── routes/
└── server.js

Contributing

We welcome contributions! To contribute to Fit-Track, follow these steps:

Forking the Repository

  1. Fork the repository by clicking the "Fork" button at the top right of the repository page on GitHub. Forking the Repository

Cloning the Repository

  1. Clone your forked repository to your local machine: 
    git clone https://github.com/your-username/Fit-Track.git
  2. Navigate to the project directory: 
    cd Fit-Track

Creating a Branch

  1. Create a new branch for your feature or bug fix (create a branch according to the issue working on): 
    git switch -c your-branch-name

Making Changes

  1. Make your changes to the codebase. You can edit the files using your preferred code editor.

Committing Changes

  1. Add the changes to the staging area: 
    git add .
  2. Commit the changes with a descriptive message: 
    git commit -m "Description of your changes"

Pushing Changes

  1. Push the changes to your forked repository: 
    git push origin your-branch-name

Creating a Pull Request

  1. Create a pull request from your forked repository to the main repository. Go to the "Pull Requests" tab on the main repository, and click "New Pull Request". Follow the instructions to create your pull request.

Let's build something great together and make Fit-Track the best it can be! ❤️🤝

License

This project is licensed under the MIT License - see the LICENSE file for details.