Skip to content

coslynx/fittrack-3d-fitness-webgl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

23 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

fitness-tracker-3d

Visualize fitness goals in an engaging 3D web application.

Developed with the software and tools below.

React Framework Frontend Technologies Three.js Tailwind CSS
git-last-commit GitHub commit activity GitHub top language

πŸ“‘ Table of Contents

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

πŸ“ Overview

The repository contains a Minimum Viable Product (MVP) called "fitness-tracker-3d" that provides a 3D landing page to visualize fitness goals and progress. Built with React, TypeScript, and Three.js, this application aims to enhance the user experience of fitness tracking.

πŸ“¦ Features

Feature Description
πŸ–ΌοΈ 3D Visualization Provides an engaging 3D environment to display fitness goals and progress.
🎨 Interactive UI Includes interactive UI elements for users to explore and understand their fitness metrics.
βš™οΈ React Components Leverages React components for modularity and maintainability, creating a clean and organized codebase.
⚑️ Optimized Performance Implements performance optimizations to ensure smooth rendering and interactivity, even on lower-end devices.
πŸ“± Responsive Design Ensures the application is responsive and accessible across various devices, including desktops, tablets, and mobiles.

πŸ“‚ Structure

└─ src
  └─ components
    └─ Hero.tsx
    └─ Features.tsx
    └─ CallToAction.tsx
    └─ Footer.tsx
    └─ Three
      └─ Model.tsx
      └─ GoalOrb.tsx
    └─ UI
      └─ Button.tsx
      └─ Card.tsx
  └─ hooks
    └─ useScrollAnimation.ts
  └─ utils
    └─ modelOptimizer.ts
  └─ App.tsx
  └─ index.tsx
└─ public
  └─ models
    └─ hero-model.glb
  └─ textures
    └─ background.jpg
└─ styles
  └─ index.css
  └─ tailwind.config.js
└─ .env
└─ tsconfig.json
└─ package.json
└─ README.md
└─ .prettierrc
└─ vite.config.ts
└─ index.html

πŸ’» Installation

Warning

πŸ”§ Prerequisites

  • Node.js v18.0.0 or higher
  • npm 6+ or yarn

πŸš€ Setup Instructions

  1. Clone the repository:
    git clone https://github.com/coslynx/fittrack-3d-fitness-webgl.git
    cd fittrack-3d-fitness-webgl
  2. Install dependencies:
    npm install
  3. Configure environment variables:
    cp .env.example .env

    [!NOTE] Make sure to fill in the .env file with the appropriate values.

πŸ—οΈ Usage

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

  1. Start the development server:

    npm run dev
  2. Access the application:

Tip

βš™οΈ Configuration

  • The application uses environment variables for configuration.
  • Key settings include VITE_APP_TITLE, VITE_API_URL, VITE_MODEL_URL, and VITE_TEXTURE_URL.

πŸ“š Examples

  • 3D Model Rendering: Demonstrates the rendering of a 3D model to visualize user fitness data.
  • Interactive Animations: Utilizes animations to enhance the user experience and highlight progress.
  • Responsive Layout: Implements responsive design to ensure the application is accessible on different devices.

🌐 Hosting

πŸš€ Deployment Instructions

Deploying to Netlify

  1. Sign up or log in to Netlify.
  2. Connect your GitHub repository to Netlify.
  3. Configure the build settings:
    • Build command: npm run build
    • Publish directory: dist
  4. Deploy your site.

πŸ”‘ Environment Variables

  • VITE_APP_TITLE: The title of the application (e.g., FitnessTracker3D).
  • VITE_API_URL: The URL for the API (e.g., http://localhost:3000/api).
  • VITE_MODEL_URL: The URL for the 3D model (e.g., /models/hero-model.glb).
  • VITE_TEXTURE_URL: The URL for the texture (e.g., /textures/background.jpg).

πŸ“„ 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: fittrack-3d-fitness-webgl

πŸ“ž 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!

3D Model Files Required

This project requires the following 3D model files that need to be created manually:

  • public/models/hero-model.glb

These placeholder files need to be replaced with actual binary 3D model files.