Shawn-Armstrong / UCSC-CSE-Association

UCSC CSE Association

Overview

• This repository contains a containerized N-tier web application
• This project seeks to be an early prototype for our organizational website

Example

Getting Started

Requirements

• Git
• Docker

Instructions

1. Clone the repository

   git clone https://github.com/Shawn-Armstrong/UCSC-CSE-Association.git

2. Start the containers:

   docker-compose up
   

3. Interact with the containers:

   • Frontend is hosted at http://localhost:3000/
   • Backend is listening on http://localhost:5000/
   • Database is listening on port 5432 with credentials username=user, password=password

Technical Details / Features

Overview

• Frontend use JavaScript's Vuejs framework in conjunction with Vuetify 3.X UI framework hosted on port 3000
• Backend uses JavaScript's Nodejs runtime in conjunction with Expressjs web application framework listening on port 5000
• Database is a PostgreSQL instance listening in port 5432 with credentials user=user, password=password

Register

sequenceDiagram
  Client->>Client: 1. Render Register component at /register route<br>2. Collect new user information
  Client->>Server: 1. Request, POST, /register, payload = user information
  Server->>Server: 1. Receive / extract user information from request object<br>2. Create query to check if username / email are free
  Server->>Database: Send query
  Database->>Database: Execute query
  Database->>Server: Send query results
  Server->>Server: Generate 

Loading

-->