/MeditationNotMedication

Meditation web application to ease chronic pain

Primary LanguageJavaScript

Meditation, Not Medication!

Server Address and Endpoint

Frontend

Backend

Technologies:

  • Frontend:

    • React + Vite

  • Backend:

    • Express
    • PostgreSQL

Features:

  • Meditation Sessions: Users can access guided meditation sessions.
  • Big Red Button: Provides users with a relevant audio guide that will ease their discomfort, ranging from guided meditation and visualization practices
  • User Authentication: Secure user accounts with authentication.

Contributors

  • Prabesh Sharma and Vasu Bhatnagar: Frontend development
  • Roman Zinkevich: Backend development
  • Zhiyuan Liu: Code Reviewer

API Endpoints

  • Retrieve Content by ID

    • Endpoint: /api/contents/:id
    • Description: Embark on a mindful journey with one "content" retrieved by id from the database.
    • Example: GET https://meditationnotmedication-production.up.railway.app/api/contents/1

  • Get All Sections

    • Endpoint: /api/sections
    • Description: Explore a tapestry of "Sections," each weaving its unique story.
    • Example: GET https://meditationnotmedication-production.up.railway.app/api/sections

  • Get Content by Section ID

    • Endpoint: /api/sections/:id
    • Description: Uncover the depth of wisdom within one "section's" treasures.
    • Example: GET https://meditationnotmedication-production.up.railway.app/api/sections/1

  • Create New User

    • Endpoint: /api/users
    • Description: Begin your meditation quest with a new user account.
    • Example: POST https://meditationnotmedication-production.up.railway.app/api/users
    • Request Body: 
      {
    "name": "NewUser",
    "password": "SecurePa$$word123"
}

  • User Login

    • Endpoint: /api/users/login
    • Description: Open the door to serenity by logging in if you've wandered here before.
    • Example: POST https://meditationnotmedication-production.up.railway.app/api/users/login
    • Request Body: 
      {
    "name": "ExistingUser",
    "password": "TheirSecretPa$$w0rd"
}

  • Get User Information

    • Endpoint: /api/users
    • Description: Peek into the mirror of self-awareness with information about the logged-in user.
    • Authorization: Bearer Token Required
    • Example: GET https://meditationnotmedication-production.up.railway.app/api/users

  • Update User Information

    • Endpoint: /api/users
    • Description: Sculpt your profile with the gentle touch of personalized changes.
    • Authorization: Bearer Token Required
    • Example: PUT https://meditationnotmedication-production.up.railway.app/api/users
    • Request Body: 
      {
    "email": "MyNewEmail@gmail.com",
    "name": "John Doe"
}

  • Change User Password

    • Endpoint: /api/users/password
    • Description: Renew your spiritual essence by changing your password.
    • Authorization: Bearer Token Required
    • Example: PUT https://meditationnotmedication-production.up.railway.app/api/users/password
    • Request Body: 
      {
    "password": "NewSecurePa$$w0rd"
}

  • Delete User Account

    • Endpoint: /api/users
    • Description: Bid farewell to your account, gracefully leaving the tranquil space.
    • Authorization: Bearer Token Required
    • Example: DELETE https://meditationnotmedication-production.up.railway.app/api/users

  • Admin: Update Content Data

    • Endpoint: /api/contents/admin/:id
    • Description: Craft and mold the essence of "content" data with divine precision.
    • Authorization: Bearer Admin Token Required
    • Example: PUT https://meditationnotmedication-production.up.railway.app/api/contents/admin/1
    • Request Body: 
      {
    "content_name": "Content Number 5",
    "description": "Enhanced and refined for supreme tranquility"
}

  • Admin: Get All Users

    • Endpoint: /api/users/admin
    • Description: Ascend to the heights of awareness with insights into all users in the database.
    • Authorization: Bearer Admin Token Required
    • Example: GET https://meditationnotmedication-production.up.railway.app/api/users/admin

  • Admin: Update User Role

    • Endpoint: /api/users/admin/:id
    • Description: Bestow roles with the wisdom of the ancients upon the chosen user.
    • Authorization: Bearer Admin Token Required
    • Example: PUT https://meditationnotmedication-production.up.railway.app/api/users/admin/1
    • Request Body: 
      {
    "role": "1"
}

  • Admin: Create New Content

    • Endpoint: /api/contents/admin
    • Description: Infuse the spiritual realm with new "content" as an admin.
    • Authorization: Bearer Admin Token Required
    • Example: POST https://meditationnotmedication-production.up.railway.app/api/contents/admin
    • Request Body: 
      {
    "content_name": "NewContent",
    "description": "NewDescription",
    "audio": "NewAudio",
    "image": "NewImage",
    "author": "NewAuthor",
    "section_name": "Section 1"
}

ERD

image