- π Overview
- π¦ Features
- π Structure
- π» Installation
- ποΈ Usage
- π Hosting
- π License
- π Authors
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.
| 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. |
ββ 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
- Clone the repository:
git clone https://github.com/coslynx/fittrack-3d-fitness-webgl.git cd fittrack-3d-fitness-webgl - Install dependencies:
npm install
- Configure environment variables:
cp .env.example .env
[!NOTE] Make sure to fill in the
.envfile with the appropriate values.
-
Start the development server:
npm run dev
-
Access the application:
- Web interface: http://localhost:5173
Tip
- The application uses environment variables for configuration.
- Key settings include
VITE_APP_TITLE,VITE_API_URL,VITE_MODEL_URL, andVITE_TEXTURE_URL.
- 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.
- Sign up or log in to Netlify.
- Connect your GitHub repository to Netlify.
- Configure the build settings:
- Build command:
npm run build - Publish directory:
dist
- Build command:
- Deploy your site.
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).
This Minimum Viable Product (MVP) is licensed under the GNU AGPLv3 license.
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
For any questions or concerns regarding this AI-generated MVP, please contact CosLynx at:
- Website: CosLynx.com
- Twitter: @CosLynxAI
Create Your Custom MVP in Minutes With CosLynxAI!
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.