Skip to content

README.md

Latest commit

 

History

History
71 lines (45 loc) · 2.95 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.95 KB

Fitness Tracking Application

Fitness Tracking Application is a web application that allows users to track their workouts, daily macros, and calories. Users can create an account, log in, and utilize various features to monitor their fitness progress.

Features

  • User Registration: Users can create an account by providing their details such as name, email, and password.
  • Authentication and Authorization: JWT-based authentication is implemented to secure user access. HttpOnly cookies are used to store the JWT token for enhanced security.
  • Role-Based Access Control: Two roles are defined: Admin and User. Admins have additional privileges such as adding new products to the system and managing user accounts.
  • Workout Tracking: Users can track their workouts by recording the intensity, burned calories, and exercise type.
  • Daily Macros and Calorie Tracking: Users can monitor their daily macros and calorie intake to maintain a healthy diet.
  • Food Catalog: Users can search for food items and add them to their daily food catalog, enabling them to track their nutrition accurately.
  • Product Management: Admins have the ability to add new products to the system, ensuring a comprehensive food catalog for users.

Technologies Used

The project is built using the following technologies:

  • Spring Boot: Provides the foundation for developing the application.
  • Spring Security: Ensures secure authentication and authorization using JWT tokens stored in HttpOnly cookies.
  • Spring Data: Simplifies database interactions with MongoDB.
  • MongoDB: A NoSQL database used for storing user accounts, workouts, and food items.
  • Docker: Used to containerize the MongoDB database for easy deployment and scalability.
  • Hibernate: An Object-Relational Mapping (ORM) framework for managing the database entities.

API Endpoints

The application exposes the following RESTful API endpoints:

  • /api/v1/auth/register - Register a new user account.
  • /api/v1/auth/authenticatelogin - User login to obtain JWT token.
  • /api/v1/auth/logout - CRUD operations for managing workouts.
  • /api/v1/user/ - CRUD operations for users
  • /api/v1/admin/users - Admin-only endpoint for managing user accounts.
  • /api/v1/admin/products - Admin-only endpoint for managing products.

Deployment using Docker

The application has been Dockerized for easier deployment and management. Below are the steps to deploy the application using Docker:

Prerequisites

Ensure that Docker is installed on your machine.

Instructions

  1. Clone the repository:

    git clone <repository_URL>
cd fitness-tracking-app

  2. Build the Docker image:

    docker build -t fitness-app .

  3. Run Docker Compose to start the application:

    docker-compose up

This will start the Fitness Tracking Application, including the Spring Boot backend, MongoDB database, and Mongo Express for managing the database. Access the application at http://localhost:8080.