Skip to content

Latest commit

 

History

History
137 lines (116 loc) · 5.43 KB

README.md

File metadata and controls

137 lines (116 loc) · 5.43 KB
Raw

FitLog Fitness Tracker MVP

Simple, effective fitness tracking for everyone.

Developed with the software and tools below.

React Framework Frontend Tech Node.js Backend 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 FitLog Fitness Tracker MVP, a simple web application for fitness enthusiasts to track their progress and share achievements. The application streamlines fitness tracking, making it easier and more engaging than complex, feature-heavy alternatives. Built with React, Node.js, and MongoDB, FitLog prioritizes ease of use and a clean user interface.

📦 Features

Feature Description
User Authentication Secure user registration and login using bcryptjs for password hashing and jsonwebtoken for JWT generation and verification.
Goal Setting Create and manage fitness goals with target values, units, and timeframes. Input validation ensures data integrity.
Progress Tracking Log daily progress manually. Progress is visualized using charts and graphs.
Social Sharing Generate a unique shareable link to view progress data.

📂 Structure

text fitlog-mvp/ ├── src/ │ ├── components/ │ │ ├── AuthButton.tsx │ │ ├── GoalCard.tsx │ │ ├── GoalForm.tsx │ │ ├── ProgressChart.tsx │ │ ├── ShareLink.tsx │ │ └── index.tsx │ ├── pages/ │ │ ├── Dashboard.tsx │ │ ├── Goals.tsx │ │ ├── Home.tsx │ │ └── index.tsx │ ├── services/ │ │ ├── api/ │ │ │ ├── auth.ts │ │ │ ├── goals.ts │ │ │ ├── progress.ts │ │ │ └── index.ts │ │ └── db/ │ │ ├── models/ │ │ │ ├── User.ts │ │ │ ├── Goal.ts │ │ │ ├── Progress.ts │ │ │ └── index.ts │ │ └── index.ts │ └── styles/ │ ├── global.css │ └── index.css ├── src/index.tsx ├── package.json └── .env

💻 Installation

🔧 Prerequisites

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

🚀 Setup Instructions

  1. Clone the repository: bash git clone https://github.com/coslynx/FitLog-Fitness-Tracker-MVP.git cd FitLog-Fitness-Tracker-MVP

  2. Install dependencies: bash npm install

  3. Set up MongoDB: Ensure a MongoDB instance is running and the DATABASE_URL in .env is correctly configured.

🏗️ Usage

🏃‍♂️ Running the MVP

  1. Start the development server: bash npm run dev

  2. Open your browser to http://localhost:3001

🌐 Hosting

Deployment instructions will be added later.

📜 License & Attribution

📄 License

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

🤖 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: FitLog-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!