Skip to content

Track fitness goals progress share achievements easily... Created at https://coslynx.com

Notifications You must be signed in to change notification settings

coslynx/FitGoalTracker-MVP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FitGoalTracker-MVP

A web application for setting, tracking, and sharing fitness goals.

Developed with the software and tools below.

React Framework Frontend Technologies Node.js Backend PostgreSQL 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 Fitness Goal Tracker MVP, a web application designed to help users set, track, and share their fitness goals. Built using React for the frontend, Node.js with Express.js for the backend, and PostgreSQL for the database, this MVP prioritizes a clean, efficient architecture and a user-friendly experience.

📦 Features

Feature Description
User Authentication Secure user registration and login using email/password. JWTs for session management.
Goal Setting Users can create, edit, and delete personalized fitness goals (weight loss, muscle gain, steps, etc.) with target values and timeframes.
Progress Tracking Users input daily/weekly progress. The system calculates progress percentages and displays them visually using charts.
Social Sharing Users can connect with friends, share progress updates, and view friends' achievements. (Simplified for MVP)

📂 Structure

fitness-tracker-mvp/
├── apps/
│   └── web/                  
│       ├── package.json      
│       ├── public/           
│       ├── src/              
│       │   ├── components/  
│       │   ├── pages/       
│       │   ├── App.tsx      
│       │   ├── index.tsx    
│       │   └── ...          
│       ├── vite.config.js   
│       └── ...
├── packages/
│   └── utils/               
│       ├── package.json      
│       ├── src/              
│       │   └── ...
│       └── ...
├── package.json             
├── tsconfig.json            
├── .eslintrc.js             
├── .prettierrc              
├── .env                     
└── Dockerfile               

💻 Installation

🔧 Prerequisites

  • Node.js v16+
  • npm 8+
  • PostgreSQL 15+

🚀 Setup Instructions

  1. Clone the repository:
    git clone https://github.com/coslynx/FitGoalTracker-MVP.git
    cd FitGoalTracker-MVP
  2. Install dependencies:
    npm install
  3. Set up the database: (Instructions will be provided separately, or you can use a pre-populated database for the MVP)
  4. Configure environment variables (copy .env.example to .env and populate)

🏗️ Usage

🏃‍♂️ Running the MVP

  1. Start the development server:
    npm run dev
  2. Access the application: http://localhost:3000

📚 Examples

  • Setting a Goal: The application provides forms for creating goals, specifying type (e.g., "Weight Loss"), target value (e.g., 10 lbs), and timeframe (e.g., "2 months"). Progress is tracked manually.
  • Viewing Progress: Progress is visualized in interactive charts, displaying percentage completion and remaining time.
  • Social Interaction (Limited MVP scope): A basic friend system is implemented; the feed displays progress updates from connected friends.

🌐 Hosting

Deployment instructions will be added later for Heroku and other platforms.

📜 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: FitGoalTracker-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!

```