GymCrowd

Overview

GymCrowd is a gym management and workout tracking platform tailored for fitness enthusiasts. The platform enables users to log workouts, set gym crowd level preferences, and receive notifications about gym activities. With robust user authentication and real-time updates, GymCrowd ensures a personalized and secure fitness experience.

Repositories

Frontend Repository: Link to Android repo
Backend Repository: Link to Backend repo (this)

Features

User Authentication: Secure user sign-up, login, token-based authentication, and logout functionality.
Workout Tracking: Log workouts, add exercises to specific sessions, and view detailed workout histories.
Gym Preferences: Set maximum acceptable crowd levels for gyms and customize preferences.
Notifications: Receive notifications for updates, alerts, and gym crowd statuses.
Real-Time Updates: Stay informed with the latest gym crowd data and activity alerts.

Project Structure

Backend (Django + PostgreSQL)

Django: Backend framework for robust application logic.
Django REST Framework (DRF): Handles API endpoints for communication with the frontend.
PostgreSQL: Relational database for storing user, workout, and notification data.
RESTful API Design: Provides a modular and scalable backend structure.

Getting Started

Prerequisites

For Simply Viewing:

None!

Our backend is fully deployed and available at the production base URL:

Base URL: http://34.86.153.211:8000/

You can access all endpoints specified in API Specification directly through this URL. However, if you wish to test or develop the backend locally, you can follow the instructions below to see how we set up the application on our local machines initially.

For Devs: Before running this project, ensure you have the following installed on your system:

Python (>=3.8)
PostgreSQL (>=13.x)
pip (Python package manager)

Tech Stack

Backend: Django, Django REST Framework
Database: PostgreSQL

Installation

Backend Setup

Clone the repository:

git clone [email protected]:<YOUR_USERNAME>/GymCrowd-backend.git
cd GymCrowd-backend

Create a .env file in the root directory with the following structure:

DATABASE_NAME=GymCrowd
DATABASE_USER=postgres
DATABASE_PWD=password
DATABASE_HOST=gymcrowd-db
DATABASE_PORT=5432
DEBUG=True
SECRET_KEY=django-insecure-key

Replace the placeholder values with your PostgreSQL database information.

Run the application using Docker Compose:
```
docker-compose up --build
```

PostgreSQL Setup

Note: This step is only required if you are running PostgreSQL outside of Docker Compose.

Installing PostgreSQL

Download and install PostgreSQL from the official website.
Follow the installation wizard and set up the following:
- Username: Choose a database admin username (e.g., postgres).
- Password: Set a strong password for the admin account.
- Port: Use the default port 5432 or customize as needed.

Configuring PostgreSQL

Note: can also be done manually through pgAdmin

Log into the PostgreSQL terminal:
```
psql -U postgres
```
Create a new database:
```
CREATE DATABASE GymCrowd;
```

Create a new user with a password:

CREATE USER gymcrowd_user WITH PASSWORD 'your-password';

Grant privileges to the new user:

GRANT ALL PRIVILEGES ON DATABASE GymCrowd TO gymcrowd_user;

Exit the PostgreSQL terminal:
```
\q
```

Usage

Running the Application

To start the application, simply run

docker-compose up --build

This command will:

Build the Docker images for the application.
Set up the PostgreSQL database and apply migrations.
Populate the database with initial data for gyms and exercises.

Access the Application

Once the application is running, you can access it at: http://127.0.0.1:8000/

Test the API

Use an API client like Postman or cURL to test the API endpoints. Make sure to include appropriate headers (e.g., Authorization tokens) where required.

Explore the Features

User Authentication: Sign up, log in, retrieve tokens, and log out.
Workout Management: Add workouts, track exercises, and retrieve workout history.
Gym Preferences: Set and update gym crowd level preferences.
Notifications: Receive notifications about gym activities and updates.

API Specification

Contributors: Adeeb Khan, Arjun Maitra, Ethan Zhang

NOTE ABOUT ERROR RESPONSES

The server should return an error response for:

POST requests, if the user does not supply one of the required fields in the body (e.g., email, password, etc.) with a status code of 400 Bad Request.
Any request if an invalid or missing parameter is provided, with an appropriate status code and error message.

Error Response Format

{
  "error": "Your error message here"
}

User Endpoints

Log in a User

POST /api/users/login/

Description:

Validates user credentials (username and password) and logs the user into the application if the credentials are valid.

Request Body

{
  "username": "user123",
  "password": "securepassword123"
}

Success Response

Status Code: 200 OK

{
  "user": {
    "user_id": <USER_ID>,
    "username": "<USER_USERNAME>",
    "name": "<USER_NAME>",
    "email": "<USER_EMAIL>",
    "preferences": [],
    "workouts": [],
    "notifications": []
  },
  "message": "Login successful."
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Username and password are required."
}

Status Code: 401 Unauthorized

{
  "error": "Invalid username or password."
}

Retrieve a User Token

POST /api/users/token/

Description:

Generates a token for an authenticated user. The token is used for authenticating protected API endpoints. Note that this route can also be used for user login.

Request Body

{
  "username": "<USER_USERNAME>",
  "password": "securepassword123"
}

Success Response

Status Code: 200 OK

{
  "token": "<USER_TOKEN>",
  "user": {
    "user_id": <USER_ID>,
    "username": "<USER_USERNAME>",
    "name": "<USER_NAME>",
    "email": "<USER_EMAIL>",
    "preferences": [],
    "workouts": [],
    "notifications": []
  }
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Username and password are required."
}

Status Code: 401 Unauthorized

{
  "error": "Invalid username or password."
}

Sign up a new user

POST /api/users/signup/

Description:

Allows users to create a new account by providing their name, email, username, and password. Passwords are hashed before being stored in the database.

Request Body

{
  "name": "<USER_NAME>",
  "email": "<USER_EMAIL>",
  "username": "<USER_USERNAME>",
  "password": "securepassword123"
}

Success Response

Status Code: 201 Created

{
  "user": {
    "user_id": "<USER_ID>",
    "username": "<USER_USERNAME>",
    "name": "<USER_NAME>",
    "email": "<USER_EMAIL>",
    "preferences": [],
    "workouts": [],
    "notifications": []
  },
  "message": "Account created successfully."
}

Error Responses

Status Code: 400 Bad Request

Missing Fields:

{
  "error": "Name, email, username, and password are required."
}

Email Already Exists:

{
  "error": "An account with this email already exists."
}

Username Already Exists:

{
  "error": "An account with this username already exists."
}

Status Code: 500 Internal Server Error

{
  "error": "Failed to create account: <ERROR_MESSAGE>"
}

Log Out a User

POST /api/users/logout/

Description:

Logs the user out by deleting the authentication token associated with their account.

Headers

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "message": "Logout successful."
}

Error Responses

Status Code: 401 Unauthorized

{
  "detail": "Authentication credentials were not provided."
}

List All User Preferences

GET /api/users/preferences/

Description:

Retrieves a list of all preferences set by the authenticated user. Each preference is linked to a gym and specifies the maximum acceptable crowd level.

Headers

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "preferences": [
    {
      "preference_id": 1,
      "user": 1,
      "gym": 2,
      "max_crowd_level": 0.8,
      "created_at": "2024-11-24T18:00:00Z"
    },
    {
      "preference_id": 2,
      "user": 1,
      "gym": 3,
      "max_crowd_level": 0.6,
      "created_at": "2024-11-25T18:00:00Z"
    }
  ]
}

Error Responses

Status Code: 403 Forbidden

{
  "detail": "Authentication credentials were not provided."
}

Create a New User Preference

POST /api/users/preferences/

Description:

Allows the authenticated user to create a new gym preference. This includes specifying the gym and the maximum acceptable crowd level.

Headers

Authorization: Token <USER_TOKEN>

Request Body

{
  "gym": 2,
  "max_crowd_level": 0.8
}

Success Response

Status Code: 201 Created

{
  "preference_id": 1,
  "user": 1,
  "gym": 2,
  "max_crowd_level": 0.8,
  "created_at": "2024-11-24T18:00:00Z"
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Gym and max_crowd_level are required."
}

Status Code: 403 Forbidden

{
  "detail": "Authentication credentials were not provided."
}

Update a User Preference

PUT /api/users/preferences/<preference_id>/

Description:

Allows the authenticated user to update an existing gym preference. This includes modifying the gym or the maximum acceptable crowd level.

Headers

Authorization: Token <USER_TOKEN>

Request Body

{
  "gym": 3,
  "max_crowd_level": 0.7
}

Success Response

Status Code: 200 OK

{
  "preference_id": 1,
  "user": 1,
  "gym": 3,
  "max_crowd_level": 0.7,
  "updated_at": "2024-11-25T18:30:00Z"
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Invalid fields provided."
}

Status Code: 403 Forbidden

{
  "detail": "Authentication credentials were not provided."
}

Status Code: 404 Not Found

{
  "error": "Preference not found."
}

Delete a User Preference

DELETE /api/users/preferences/<preference_id>/

Description:

Allows the authenticated user to delete an existing gym preference.

Headers

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "message": "Preference deleted successfully."
}

Error Responses

Status Code: 403 Forbidden

{
  "detail": "Authentication credentials were not provided."
}

Status Code: 404 Not Found

{
  "error": "Preference not found."
}

Gym Endpoints

List All Gyms

GET /api/gyms/

Description:

Fetches a list of all gyms in the system, including their details and associated crowd data.

Success Response

Status Code: 200 OK

{
  "gyms": [
    {
      "gym_id": <GYM_ID>,
      "name": "<GYM_NAME>",
      "location": "<GYM_LOCATION>",
      "type": "<GYM_TYPE>",
      "crowd_data": [
        {
          "crowd_id": <CROWD_ID>,
          "occupancy": <OCCUPANCY>,
          "percentage_full": <PERCENTAGE_FULL>,
          "last_updated": "<LAST_UPDATED>"
        }
      ]
    },
    ...
  ]
}

Get a Specific Gym

GET /api/gyms/<id>/

Description:

Fetches the details of a specific gym by its ID, including associated crowd data.

Success Response

Status Code: 200 OK

{
  "gym_id": <GYM_ID>,
  "name": "<GYM_NAME>",
  "location": "<GYM_LOCATION>",
  "type": "<GYM_TYPE>",
  "crowd_data": [
    {
      "crowd_id": <CROWD_ID>,
      "occupancy": <OCCUPANCY>,
      "percentage_full": <PERCENTAGE_FULL>,
      "last_updated": "<LAST_UPDATED>"
    }
  ]
}

Error Responses

Status Code: 404 Not Found

{
  "error": "Gym not found."
}

List All Crowd Data Entries

GET /api/gyms/crowddata/

Description:

Fetches a list of all crowd data entries in the system.

Success Response

Status Code: 200 OK

{
  "crowd_data": [
    {
      "crowd_id": <CROWD_ID>,
      "gym": <GYM_ID>,
      "occupancy": <OCCUPANCY>,
      "percentage_full": <PERCENTAGE_FULL>,
      "last_updated": "<LAST_UPDATED>"
    },
    ...
  ]
}

Get a Specific Crowd Data Entry

GET /api/gyms/crowddata/<id>/

Description:

Fetches details of a specific crowd data entry by its ID.

Success Response

Status Code: 200 OK

{
  "crowd_id": <CROWD_ID>,
  "gym": <GYM_ID>,
  "occupancy": <OCCUPANCY>,
  "percentage_full": <PERCENTAGE_FULL>,
  "last_updated": "<LAST_UPDATED>"
}

Error Responses

Status Code: 404 Not Found

{
  "error": "Crowd data entry not found."
}

Workout Endpoints

List All Exercises

GET /api/workouts/exercises/

Description:

Fetches a list of all available exercises in the system.

Requires:

No authentication required.

Success Response

Status Code: 200 OK

{
  "exercises": [
    {
      "exercise_id": <EXERCISE_ID>,
      "name": "<EXERCISE_NAME>",
      "body_part": "<BODY_PART>",
      "equipment": "<EQUIPMENT>",
      "gif_url": "<GIF_URL>",
      "target": "<TARGET>",
      "secondary_muscles": "<SECONDARY_MUSCLES>",
      "instructions": "<INSTRUCTIONS>"
    },
    ...
  ]
}

Get a Specific Exercise

GET /api/workouts/exercises/<exercise_id>/

Description:

Fetches details of a specific exercise by its ID.

Requires:

No authentication required.

Success Response

Status Code: 200 OK

{
  "exercise_id": <EXERCISE_ID>,
  "name": "<EXERCISE_NAME>",
  "body_part": "<BODY_PART>",
  "equipment": "<EQUIPMENT>",
  "gif_url": "<GIF_URL>",
  "target": "<TARGET>",
  "secondary_muscles": "<SECONDARY_MUSCLES>",
  "instructions": "<INSTRUCTIONS>"
}

Error Responses

Status Code: 404 Not Found

{
  "error": "Exercise not found."
}

List All User Workouts

GET /api/workouts/

Description:

Fetches a list of all workout sessions for the authenticated user.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "workouts": [
    {
      "workout_id": <WORKOUT_ID>,
      "user": <USER_ID>,
      "date": "<WORKOUT_DATE>",
      "created_at": "<CREATED_AT>",
      "workout_exercises": [
        {
          "entry_id": <ENTRY_ID>,
          "exercise": <EXERCISE_ID>,
          "sets": <SETS>,
          "reps": <REPS>,
          "weight": <WEIGHT>
        },
        ...
      ]
    },
    ...
  ]
}

Create a New Workout Session

POST /api/workouts/

Description:

Creates a new workout session for the authenticated user.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Request Body

{
  "date": "<WORKOUT_DATE>"
}

Success Response

Status Code: 201 Created

{
  "workout_id": <WORKOUT_ID>,
  "user": <USER_ID>,
  "date": "<WORKOUT_DATE>",
  "created_at": "<CREATED_AT>",
  "workout_exercises": []
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Invalid or missing fields in request."
}

Get Details of a Specific Workout

GET /api/workouts/<workout_id>/

Description:

Fetches details of a specific workout session by its ID.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "workout_id": <WORKOUT_ID>,
  "user": <USER_ID>,
  "date": "<WORKOUT_DATE>",
  "created_at": "<CREATED_AT>",
  "workout_exercises": [
    {
      "entry_id": <ENTRY_ID>,
      "exercise": <EXERCISE_ID>,
      "sets": <SETS>,
      "reps": <REPS>,
      "weight": <WEIGHT>
    },
    ...
  ]
}

Error Responses

Status Code: 404 Not Found

{
  "error": "Workout not found."
}

List All Exercises in User Workouts

GET /api/workouts/workout-exercises/

Description:

Fetches all exercises logged in the authenticated user's workouts.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "workout_exercises": [
    {
      "entry_id": <ENTRY_ID>,
      "workout": <WORKOUT_ID>,
      "exercise": <EXERCISE_ID>,
      "sets": <SETS>,
      "reps": <REPS>,
      "weight": <WEIGHT>
    },
    ...
  ]
}

Add an Exercise to a Workout

POST /api/workouts/workout-exercises/

Description:

Adds a new exercise entry to a specific workout session for the authenticated user.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Request Body

{
  "workout": <WORKOUT_ID>,
  "exercise": <EXERCISE_ID>,
  "sets": <SETS>,
  "reps": <REPS>,
  "weight": <WEIGHT>
}

Success Response

Status Code: 201 Created

{
  "entry_id": <ENTRY_ID>,
  "workout": <WORKOUT_ID>,
  "exercise": <EXERCISE_ID>,
  "sets": <SETS>,
  "reps": <REPS>,
  "weight": <WEIGHT>
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Invalid or missing fields in request."
}

Status Code: 403 Forbidden

{
  "error": "You do not have permission to add exercises to this workout."
}

Notifications Endpoints

List All Notifications

GET /api/notifications/

Description:

Fetches a list of all notifications in the system.

Requires:

No authentication required.

Success Response

Status Code: 200 OK

{
  "notifications": [
    {
      "notification_id": 1,
      "user": 12,
      "gym": 3,
      "message": "Your session is confirmed.",
      "sent_at": "2024-01-01T12:00:00Z"
    },
    ...
  ]
}

Create a New Notification

POST /api/notifications/

Description:

Creates a new notification associated with the authenticated user.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Request Body

{
  "gym": <GYM_ID>,
  "message": "<NOTIFICATION_MESSAGE>"
}

Success Response

Status Code: 201 Created

{
  "notification_id": <NOTIFICATION_ID>,
  "user": <USER_ID>,
  "gym": <GYM_ID>,
  "message": "<NOTIFICATION_MESSAGE>",
  "sent_at": "<TIMESTAMP>"
}

Error Responses

Status Code: 400 Bad Request

{
  "error": "Invalid or missing fields in request."
}

Get a Specific Notification

GET /api/notifications/<notification_id>/

Description:

Fetches details of a specific notification by its ID.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "notification_id": <NOTIFICATION_ID>,
  "user": <USER_ID>,
  "gym": <GYM_ID>,
  "message": "<NOTIFICATION_MESSAGE>",
  "sent_at": "<TIMESTAMP>"
}

Error Responses

Status Code: 404 Not Found

{
  "error": "Notification not found."
}

List Notifications for a User

GET /api/notifications/user/<user_id>/

Description:

Fetches all notifications for a specific user.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 200 OK

{
  "notifications": [
    {
      "notification_id": 1,
      "gym": 3,
      "message": "Your session is confirmed.",
      "sent_at": "2024-01-01T12:00:00Z"
    },
    ...
  ]
}

Error Responses

Status Code: 403 Forbidden

{
  "error": "You do not have permission to view these notifications."
}

Delete a notification

DELETE /api/notifications/<notification_id>/

Description:

Deletes a specific notification by its ID.

Requires:

A token in the header.

Header:

Authorization: Token <USER_TOKEN>

Success Response

Status Code: 204 No Content

Error Responses

Status Code: 404 Not Found

{
  "error": "Notification not found."
}

Name		Name	Last commit message	Last commit date
Latest commit History 64 Commits
apps		apps
gymcrowd		gymcrowd
scripts		scripts
.dockerignore		.dockerignore
.gitignore		.gitignore
Dockerfile		Dockerfile
GymCrowd-backend_db_diagram.png		GymCrowd-backend_db_diagram.png
GymCrowd.postman_collection.json		GymCrowd.postman_collection.json
README.md		README.md
docker-compose.yml		docker-compose.yml
manage.py		manage.py
requirements.txt		requirements.txt

AdeebK1129/GymCrowd-backend

Folders and files

Latest commit

History

Repository files navigation

GymCrowd

Overview

Repositories

Features

Project Structure

Backend (Django + PostgreSQL)

Table of Contents

Getting Started

Prerequisites

Tech Stack

Installation

Backend Setup

PostgreSQL Setup

Installing PostgreSQL

Configuring PostgreSQL

Usage

Running the Application

Access the Application

Test the API

Explore the Features

API Specification

NOTE ABOUT ERROR RESPONSES

Error Response Format

User Endpoints

Log in a User

Description:

Request Body

Success Response

Error Responses

Retrieve a User Token

Description:

Request Body

Success Response

Error Responses

Sign up a new user

Description:

Request Body

Success Response

Error Responses

Log Out a User

Description:

Headers

Success Response

Error Responses

List All User Preferences

Description:

Headers

Success Response

Error Responses

Create a New User Preference

Description:

Headers

Request Body

Success Response

Error Responses

Update a User Preference

Description:

Headers

Request Body

Success Response

Error Responses

Delete a User Preference

Description:

Headers

Success Response

Error Responses

Gym Endpoints

List All Gyms

Description:

Success Response

Get a Specific Gym

Description:

Success Response

Error Responses

List All Crowd Data Entries