UH-Spring2023 COSC4353: Software Design

Team 52 Members

• Quang Du
• Han Hoang
• Minh Nguyen
• Elinnoel Nuñez

Fuel Quote Rate Prediction

Description

Project detail document - Will update later with requirements

Technology Stack

• Frontend: ReactJS
• Backend: ExpressJS
• Database: PostgreSQL
• Libraries:
  • Components: Material UI
  • Styling: Bootstrap
  • Request: Axios
  • Unit Testing: Jest

Demo

• Walk-through video: [link video if we make one]
• Screenshots: (will provide later)

Installation

• Requirements:
  • Git
  • Visual Studio Code (or other IDEs or code editors)
  • Node v18
  • We use npm as our package manager
  • PostgreSQL
• Install:
  • Clone this repository: git clone https://github.com/ndminhvn/COSC4353_Group52
  • Frontend:
    • Go to client folder: cd client
    • Install dependencies: npm install
    • Create a new .env file: cp .env.example .env
    • Fill in the .env file
    • Start server: npm start
  • Backend:
    • Go to server folder: cd server
    • Install dependencies: npm install
    • Create a new .env file: cp .env.example .env
    • Fill in the .env file
    • Start server: npm start
    • Start unit-test: npm test
  • Database:
    • Install Postgres 15 on your computer and start the database: https://www.postgresql.org/download/
    • pgAdmin as database manager: https://www.pgadmin.org/download/
      • Register a new server.
      • Create a new database.
      • Import the tables using server/database/dbSchema.sql.
      • Go to your server/.env file and fill in your database connection.
    • If successfully connected, prompt will display during npm start (backend)