README.md

COMP3005 Final Project

This Project is for COMP3005 Database Management Systems Winter 2024, Option 2.

Team Members: Andrew Verbovsky, Zhenxuan Ding, Jiayu Hu

Description

This is a Full-Stack web application designed to mimick a Health and Fitness Club Management System for COMP3005 for the Winter 2024 semester at Carleton University.

The project incorporates a PostgreSQL DB interfaced with using the pg client.

A Vercel-Postgres based version is deployed on Vercel.

Built With

• Next.js - Web Framework
• NextAuth.js - Authentication
• PostgreSQL - Relational Database
• Node-Postgres - Node.js PostgreSQL client
• Mantine 7 - UI components Library
• Mantine React Table v2 - Table components

Getting Started

Dependencies

• Node and NPM package manager
• A local or remote PostgreSQL server
• A Desktop Web Browser

File/Folder Structure

Structure

├── Documentation - (Diagrams)
│   ├── Diagrams.drawio
│   ├── ER Diagram.png
│   └── Schema.png
├── Frontend - (Directory for Next JS Webapp Frontend)
│   ├── .env.local - (PLACE YOUR DATABASE CONNECTION INFO HERE)
│   ├── db.ts - (A file defining some types and DB connection read from environment variables)
│   ├── components (React components)
│   └── pages (Web pages)
│       └── api (All API functions corresponding to outlined features)
├── GRADING.md - (A copy of the Project Grading Scheme in markdown format)
├── Project_COMP_3005_W24_V2.pdf - (Project Specifications)
├── Project Report.pdf - (Project Report)
├── README.md
└── SQL - (SQL query scripts to inititalize the Database and populate it with data)
    ├── DDL.sql - Script to define database structure
    ├── DML.sql - Script to populate with initial data
    └── DQL.sql - Script to view database table data

---

Running the Application Front End

• Ensure a local (or remote) PostgreSQL server is running

• Navigate to the Frontend/ directory

• Create a .env.local file and supply it with the following information:

  •     DB_HOST=[your_database_host]
        DB_PORT=[your_database_port]
        DB_USER=[your_database_name]
        DB_PASSWORD=[your_database_password]
        DB_NAME=[your_database_name]
        NEXTAUTH_SECRET="SOMERANDOMSTRINGOFCHARACTERS"

• Run the following commands in your terminal:

  • npm install
  • npm run dev
  • ✨ Proceed to localhost:3000/ in your web browser and navigate the Web Application ✨
  • Optional: Play around with it, or something like that.

Authors

• Andrew Verbovsky
• Zhenxuan Ding
• Jiayu Hu

Acknowledgements

THIS FINAL PROJECT IS FOR COMP3005 WINTER 2024. Please do not use without permission or to commit any academic integrity violations.