Skip to content

Track fitness goals share progress with friends. Simple goal setting and tracking MVP... Created at https://coslynx.com

Notifications You must be signed in to change notification settings

coslynx/FitPulse-Fitness-Tracker-MVP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

45 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

FitPulse Fitness Tracker MVP

A simple, effective, and socially engaging fitness tracking web application

Developed with the software and tools below.

React Framework Frontend Technologies Backend Technologies MongoDB Database
git-last-commit GitHub commit activity GitHub top language

πŸ“‘ Table of Contents

  • πŸ“ Overview
  • πŸ“¦ Features
  • πŸ“‚ Structure
  • πŸ’» Installation
  • πŸ—οΈ Usage
  • 🌐 Hosting
  • πŸ“„ License
  • πŸ‘ Authors

πŸ“ Overview

This repository contains the FitPulse Fitness Tracker MVP, a web application designed to help users set, track, and share their fitness goals. Built with a focus on simplicity and user engagement, it provides a streamlined experience for consistent fitness tracking. The core tech stack includes React for the frontend, Node.js with Express.js for the backend API, and MongoDB for data persistence.

πŸ“¦ Features

Feature Description
πŸ§‘β€πŸ’» User Authentication Secure user registration and login using email/password. Password hashing is done using bcrypt. JWTs are used for authentication.
🎯 Goal Setting Users can define custom fitness goals with specific targets and deadlines. Supports various goal types (weight loss, distance, etc.).
πŸ“ˆ Progress Tracking Users log their workouts, and the app calculates progress toward their goals. Progress is visualized using charts.
πŸ—£οΈ Social Sharing Users can share progress updates via a simple copy-to-clipboard feature (Direct social media integration is a future enhancement).
πŸ“Š Data Visualization Progress toward goals is displayed using charts, providing clear visual feedback.
πŸ“± Responsive Design The application is responsive across different devices (desktop, tablet, mobile).

πŸ“‚ Structure

fitness-tracker/
β”œβ”€β”€ apps/
β”‚   └── web/          // React frontend application
β”‚       β”œβ”€β”€ package.json
β”‚       β”œβ”€β”€ public/
β”‚       β”‚   └── index.html
β”‚       β”œβ”€β”€ src/
β”‚       β”‚   β”œβ”€β”€ App.tsx
β”‚       β”‚   β”œβ”€β”€ index.tsx
β”‚       β”‚   β”œβ”€β”€ components/ ...
β”‚       β”‚   β”œβ”€β”€ pages/ ...
β”‚       β”‚   └── ...
β”‚       └── ...
└── backend/         // Node.js/Express backend API
    β”œβ”€β”€ package.json
    β”œβ”€β”€ src/
    β”‚   └── server.ts
    └── ...

πŸ’» Installation

πŸ”§ Prerequisites

  • Node.js v18+
  • npm 8+
  • MongoDB 6.0+

πŸš€ Setup Instructions

  1. Clone the repository:

    git clone https://github.com/coslynx/FitPulse-Fitness-Tracker-MVP.git
    cd FitPulse-Fitness-Tracker-MVP
  2. Navigate to the frontend directory:

    cd apps/web

    Install frontend dependencies:

    npm install
  3. Navigate to the backend directory:

    cd ../../backend

    Install backend dependencies:

    npm install
  4. Set up the database (ensure MongoDB is running):

    • You'll need to create a database named "fitness-tracker" in your MongoDB instance. No additional setup is required for this MVP.
  5. Configure environment variables:

    • Create a .env file in both the frontend (apps/web) and backend directories, using the .env.example files as templates, and fill in your JWT_SECRET and database connection string.

πŸ—οΈ Usage

πŸƒβ€β™‚οΈ Running the MVP

  1. Start the backend development server:
    cd ../../backend
    npm run dev
  2. In a separate terminal, start the frontend development server:
    cd ../../apps/web
    npm run dev
  3. Access the application:
    • Web interface: http://localhost:3000
    • API endpoint (for testing purposes): http://localhost:3001/api

βš™οΈ Configuration

  • Environment variables are stored in .env files (frontend and backend).
  • JWT_SECRET in .env is crucial for secure authentication. Make sure this is set to a strong, unique value.

πŸ“š Examples

  • User Registration: Use the web interface to create an account.
  • Setting a Fitness Goal: Navigate to the Goals page, fill out the form, and create a goal.
  • Logging a Workout: Navigate to the Workouts page, record your workout data, and save it.

🌐 Hosting

This MVP can be deployed to any platform that supports Node.js and React applications. Heroku is a suggested option. You'll need to configure the environment variables appropriately for your chosen platform.

πŸ“„ License & Attribution

πŸ“„ License

This Minimum Viable Product (MVP) is licensed under the GNU AGPLv3 license.

πŸ€– AI-Generated MVP

This MVP was entirely generated using artificial intelligence through CosLynx.com.

No human was directly involved in the coding process of the repository: FitPulse-Fitness-Tracker-MVP

πŸ“ž Contact

For any questions or concerns regarding this AI-generated MVP, please contact CosLynx at:

🌐 CosLynx.com

Create Your Custom MVP in Minutes With CosLynxAI!

Developers CosLynx Website Backed By Backdrop Build Finalist
```