Skip to content

Latest commit

 

History

History
200 lines (180 loc) · 7.6 KB

README.md

File metadata and controls

200 lines (180 loc) · 7.6 KB

Fitness-Tracker-Platform-MVP

A web application to track your fitness goals and share progress with friends.

Developed with the software and tools below.

Framework: Next.js Frontend: TypeScript, React, HTML, CSS Backend: Node.js Database: PostgreSQL
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-Tracker-Platform-MVP, a web application built with Next.js, TypeScript, React, HTML, CSS, Node.js, and PostgreSQL. It allows users to set and track fitness goals, monitor progress, and share achievements with friends.

📦 Features

Feature Description
🔐 User Authentication Users can securely log in and register using Google Sign-In.
🎯 Goal Setting Users can create customized fitness goals with specific targets and timelines.
📊 Progress Tracking Users can log their daily activities and track their progress against their goals.
📈 Data Visualization Interactive charts and graphs provide visual representations of progress.
💬 Social Sharing Users can share their achievements and progress updates with friends within the app.
🔒 Data Privacy The app prioritizes user data security and complies with relevant data privacy regulations.

📂 Structure

Fitness-Tracker-Platform-MVP
├── public
│   ├── assets
│   │   ├── fonts
│   │   │   └── ...
│   │   └── images
│   │       └── ...
│   ├── favicon.ico
│   └── index.html
├── pages
│   ├── api
│   │   ├── auth
│   │   │   └── [...nextauth].ts
│   │   ├── goals
│   │   │   ├── [id].ts
│   │   │   └── index.ts
│   │   ├── users
│   │   │   ├── [id].ts
│   │   │   └── index.ts
│   │   └── activityLogs
│   │       └── [id].ts
│   ├── _app.tsx
│   ├── _document.tsx
│   ├── index.tsx
│   ├── login.tsx
│   ├── signup.tsx
│   ├── dashboard.tsx
│   └── goal.tsx
├── components
│   ├── layout
│   │   ├── Header.tsx
│   │   ├── Footer.tsx
│   │   └── Sidebar.tsx
│   ├── ui
│   │   ├── Button.tsx
│   │   ├── Card.tsx
│   │   ├── Input.tsx
│   │   ├── Modal.tsx
│   │   └── Loader.tsx
│   ├── features
│   │   ├── auth
│   │   │   ├── LoginForm.tsx
│   │   │   └── SignupForm.tsx
│   │   ├── dashboard
│   │   │   ├── GoalsList.tsx
│   │   │   ├── RecentActivity.tsx
│   │   │   └── AnalyticsChart.tsx
│   │   ├── goal
│   │   │   ├── GoalForm.tsx
│   │   │   ├── ActivityLogForm.tsx
│   │   │   └── ProgressChart.tsx
│   │   └── social
│   │       └── SocialFeed.tsx
│   └── common
│       ├── Error.tsx
│       └── Success.tsx
├── lib
│   ├── api
│   │   └── client.ts
│   ├── hooks
│   │   ├── useUser.ts
│   │   ├── useGoal.ts
│   │   ├── useActivityLog.ts
│   │   └── useSocialFeed.ts
│   ├── auth
│   │   └── auth.ts
│   └── utils
│       ├── formatters.ts
│       ├── validators.ts
│       ├── constants.ts
│       └── helpers.ts
├── styles
│   ├── globals.css
│   └── theme.ts
├── prisma
│   └── schema.prisma
├── .env
├── .eslintrc.js
├── next.config.js
├── package.json
└── README.md

💻 Installation

🔧 Prerequisites

  • Node.js
  • npm
  • Docker

🚀 Setup Instructions

  1. Clone the repository:
    • git clone https://github.com/coslynx/Fitness-Tracker-Platform-MVP.git
  2. Navigate to the project directory:
    • cd Fitness-Tracker-Platform-MVP
  3. Install dependencies:
    • npm install

🏗️ Usage

🏃‍♂️ Running the MVP

  1. Start the development server:
    • npm run dev
  2. Open your browser and navigate to http://localhost:3000.

⚙️ Configuration

Adjust configuration settings in .env.

📚 Examples

  • 📝 Example 1: Create an account using Google Sign-In and set your first fitness goal.
  • 📝 Example 2: Track a workout session and see your progress towards your goal.
  • 📝 Example 3: Share your latest achievement with friends on the social feed.

🌐 Hosting

🚀 Deployment Instructions

  1. Build the application:
    • npm run build
  2. Deploy to Vercel:

🔑 Environment Variables

  • DATABASE_URL: Your PostgreSQL database URL.
  • GOOGLE_CLIENT_ID: Your Google Sign-In Client ID.
  • GOOGLE_CLIENT_SECRET: Your Google Sign-In Client Secret.

📜 License & Attribution

📄 License

This 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: Fitness-Tracker-Platform-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!