EPICS Team Builder

Overview

This project is for the EPICS program that helps the Directors to automatically create teams. It works by sorting a list of students, available projects, and partners into one group based on an algorithm. The purpose of this project is to:

• Steamline the team sorting and creation process
• Keep track of the available projects and partners available

Users/Roles

User/Administration and Directors of EPICS

• View all teams and projects
• Manage teams, projects, partners
• Admin privileges such as adding/removing students from teams
• Look at data analytics

Functional Requirements

Team Creation Functionality

• The user shall be able to create teams based on the projects available and the student's preference
• The user shall be able to update and modify current teams

Team/Project Viewing Functionality

• The page shall display the current created teams and availabe projects, students, and partners

Tech Stack

• Front End: Vue, Nuxt
• Database: PostgresSQL
• Other packages: Prisma
• Other technologies: Postman, Node.js, Type Script Execute

Vue

Look at the Vue 3 documentation to learn more about how to install and operate.

Nuxt

Look at the Nuxt 3 documentation to learn more about how to install and operate.

PostgresSQL

Look at the Postgres documentation to learn more about how to install and operate.

Prisma

Look at the Prisma documentation to learn more about how to install and operate.

Postman

Look at the Postman documentation to learn more about how to install and operate.

Node.js

Look at the Node.js documentation to learn more about how to install and operate.

Type Script Execute

Look at the Type Script Execute documentation to learn more about how to install and operate.

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

Start/run the development server on http://localhost:3000 (Useful for seeing results of your code/see a local verison of the application):

# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

# bun
bun run preview

Check out the deployment documentation for more information.