fitness-tracker-app

Track fitness goals, monitor progress, and share with friends.

Developed with the software and tools below.

📑 Table of Contents

• 📍 Overview
• 📦 Features
• 📂 Structure
• 💻 Installation
• 🏗️ Usage
• 🌐 Hosting
• 📄 License
• 👏 Authors

📍 Overview

The fitness-tracker-app is a web application built as a Minimum Viable Product (MVP) that enables users to track their fitness goals, monitor their progress, and share their achievements with friends. It's designed for fitness enthusiasts who seek an easy-to-use platform for managing their fitness journey. The application uses React for the frontend and Node.js for the backend, with data stored in SQLite.

📦 Features

📂 Structure

 ├── README.md
 ├── package.json
 ├── components
 │   ├── Button.jsx
 │   ├── Input.jsx
 │   ├── Modal.jsx
 │   ├── LoginForm.jsx
 │   ├── SignupForm.jsx
 │   ├── GoalCard.jsx
 │   ├── GoalForm.jsx
 │   ├── GoalList.jsx
 │   ├── ProgressChart.jsx
 │   ├── ProgressInput.jsx
 │   ├── Header.jsx
 │   └── Footer.jsx
 ├── pages
 │   ├── Home.jsx
 │   ├── Dashboard.jsx
 │   ├── Goals.jsx
 │   └── Profile.jsx
 ├── hooks
 │   ├── useAuth.js
 │   └── useFetch.js
 ├── context
 │   └── AuthContext.js
 ├── services
 │   ├── api.js
 │   └── auth.js
 ├── utils
 │   ├── helpers.js
 │   └── validators.js
 ├── styles
 │   └── global.css
 ├── public
 │   ├── index.html
 │   └── favicon.ico
 ├── types
 │   └── index.js
 ├── api
 │   └── index.js
 ├── models
 │   └── index.js
 ├── controllers
 │   └── index.js
 ├── middlewares
 │   └── authMiddleware.js
 ├── config
 │   └── database.js
 ├── tests
 │   ├── components
 │   │   ├── Button.test.js
 │   │   └── GoalForm.test.js
 │   └── services
 │       ├── api.test.js
 │       └── auth.test.js
 ├── constants
 │   └── index.js
 ├── .env
 ├── startup.sh
 └── commands.json

💻 Installation

🚀 Setup Instructions

1. Clone the repository:

   git clone https://github.com/coslynx/fitness-tracker-app.git
   cd fitness-tracker-app

2. Install dependencies:

   npm install

3. Create and configure the .env file:

    cp .env.example .env

   • Update environment variables in .env to match your setup.
   • REACT_APP_API_BASE_URL defaults to http://localhost:8080.
   • JWT_SECRET needs a secure key.
   • DB_* variables for database connection.

🏗️ Usage

🏃‍♂️ Running the MVP

1. Start the development server:

   npm start

2. Access the application:
   • Web interface: http://localhost:3000
   • API endpoint: http://localhost:8080/api

📚 Examples

Provide specific examples relevant to the MVP's core features:

• 📝 User Registration:

  curl -X POST http://localhost:8080/api/signup \
    -H "Content-Type: application/json" \
    -d '{"email": "user@example.com", "password": "securepass123"}'

• 📝 User Login:

  curl -X POST http://localhost:8080/api/login \
    -H "Content-Type: application/json" \
    -d '{"email": "user@example.com", "password": "securepass123"}'

• 📝 Setting a Fitness Goal:

   curl -X POST http://localhost:8080/api/goals \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer YOUR_JWT_TOKEN" \
       -d '{"name": "Run a Marathon", "target": 42, "unit": "km", "startDate": "2024-01-01", "endDate": "2024-12-31"}'

• 📝 Logging Progress:

  curl -X POST http://localhost:8080/api/progress \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer YOUR_JWT_TOKEN" \
      -d '{"goalId": 1, "value": 5, "date": "2024-01-15"}'

🌐 Hosting

🚀 Deployment Instructions

Provide detailed, step-by-step instructions for deploying to a suitable platform.

Deploying to a Cloud Provider (e.g., AWS, Google Cloud, or Azure)

1. Set up a virtual server:

• Provision a virtual machine with Node.js and npm installed.

2. Clone the repository:

• Use git clone to download the project to the server.

3. Install dependencies:

• Run npm install to set up the required packages.

4. Configure Environment Variables:
   • Configure the .env variables in the hosting environment.
   • Ensure all variables are securely set including database credentials, and JWT secret.
5. Build the React App:

    npm run build

6. Start the Application:
   • Use a process manager like pm2 or systemd to run the Node.js application:

       npm run start

🔑 Environment Variables

Provide a comprehensive list of all required environment variables, their purposes, and example values:

• REACT_APP_API_BASE_URL: Base URL for the API, e.g., http://localhost:8080 or https://api.example.com
• JWT_SECRET: Secret key for JWT token generation, e.g., thisIsARandomSecretKeyForJWTWhichIsLongEnough
• DB_NAME: Database name. e.g., fitness_tracker_db
• DB_HOST: Host address for the database, e.g., localhost
• DB_USER: Database username e.g., user
• DB_PASSWORD: Database password, e.g., password
• DB_PORT: Port number for the database connection, e.g., 5432

📜 API Documentation

🔍 Endpoints

Provide a comprehensive list of all API endpoints, their methods, required parameters, and expected responses:

• POST /api/login
  • Description: User login and token generation.
  • Body: {"email": string, "password": string}
  • Response: {"user": object, "token": string}
• POST /api/signup
  • Description: User registration and token generation.
  • Body: {"email": string, "password": string}
  • Response: {"user": object, "token": string}
• GET /api/goals
  • Description: Fetch all goals for the authenticated user.
  • Headers: Authorization: Bearer YOUR_JWT_TOKEN
  • Response: [{"id": number, "userId": number, "name": string, "description": string, "target": number, "unit": string, "startDate": date, "endDate": date}]
• POST /api/goals
  • Description: Create a new fitness goal.
  • Headers: Authorization: Bearer YOUR_JWT_TOKEN
  • Body: {"name": string, "description": string, "target": number, "unit": string, "startDate": date, "endDate": date}
  • Response: {"id": number, "userId": number, "name": string, "description": string, "target": number, "unit": string, "startDate": date, "endDate": date}
• PUT /api/goals/:id
  • Description: Update an existing goal.
  • Headers: Authorization: Bearer YOUR_JWT_TOKEN
  • Body: {"name": string, "description": string, "target": number, "unit": string, "startDate": date, "endDate": date}
  • Response: {"id": number, "userId": number, "name": string, "description": string, "target": number, "unit": string, "startDate": date, "endDate": date}
• DELETE /api/goals/:id
  • Description: Delete a goal.
  • Headers: Authorization: Bearer YOUR_JWT_TOKEN
  • Response: 204 No Content
• POST /api/progress
  • Description: Add progress data for a specific goal.
  • Headers: Authorization: Bearer YOUR_JWT_TOKEN
  • Body: {"goalId": number, "value": number, "date": date}
  • Response: {"id": number, "goalId": number, "value": number, "date": date}

🔒 Authentication

All protected routes require a valid JWT token, which can be acquired during the login or signup process. Include the token in the Authorization header:

Authorization: Bearer YOUR_JWT_TOKEN

📝 Examples

Provide examples of API usage, including request and response bodies:

# Signup user
curl -X POST http://localhost:8080/api/signup \
    -H "Content-Type: application/json" \
    -d '{"email": "testuser@example.com", "password": "securepassword123"}'

# Response
{
    "user": {
        "id": 1,
        "email": "testuser@example.com"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

# Login user
curl -X POST http://localhost:8080/api/login \
    -H "Content-Type: application/json" \
    -d '{"email": "testuser@example.com", "password": "securepassword123"}'

# Response
{
    "user": {
        "id": 1,
        "email": "testuser@example.com"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

# Create a new goal
curl -X POST http://localhost:8080/api/goals \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_JWT_TOKEN" \
    -d '{"name": "Run 5K", "target": 5, "unit": "km", "startDate": "2024-01-01", "endDate": "2024-03-31"}'

# Response
{
    "id": 1,
    "userId": 1,
    "name": "Run 5K",
    "description": null,
    "target": 5,
    "unit": "km",
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-03-31T00:00:00.000Z"
}

# Add progress to a goal
curl -X POST http://localhost:8080/api/progress \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_JWT_TOKEN" \
    -d '{"goalId": 1, "value": 2, "date": "2024-01-15"}'
# Response
{
    "id": 1,
    "goalId": 1,
    "value": 2,
    "date": "2024-01-15T00:00:00.000Z"
}

🌐 CosLynx.com

Create Your Custom MVP in Minutes With CosLynxAI!