Group 1 - CS261 Group Project

Members:

• Serene Alrawi
• Shayan Borhani Yazdi
• Louis Hudson
• Gabriel Hughes
• Xun Khang Tan
• Hao-Yen Tang
• Alara Tindall

Requirements

• Python 3.11 or higher
  • Make sure pip, pipenv and setuptools are installed and upgraded to the latest version by running pip3 install --upgrade pip pipenv setuptools.
• Node.js LTS or higher and npm
  • Note: the latest versions of Node.js may output a warning when the website is running.
• MySQL 8 or higher
  • For macOS Homebrew users, run brew install mysql.
  • For Linux, you should use the package manager specific to your distribution.
• (Optional) pnpm

Installation

• Clone the repository by running git clone https://github.com/thiswasdumb/SoftEngProject.git.

• Enter the project directory with cd tradetalker and install the dependencies with npm i (or pnpm i if you wish to use pnpm.)

• Setup the MySQL server:

  • Start the server. (On macOS, run mysql.server start)
  • Access the server by running mysql -u root.
  • Create the tradetalkerdb database. (CREATE DATABASE tradetalkerdb;)
  • Exit the server by running exit.

• Run the development server with npm run dev or pnpm dev.

  • If an error shows up containing the message /bin/sh: pkg-config: command not found, try installing pkg-config by running brew install pkg-config.

• Wait until the Flask server is ready, and open http://localhost:3000 with your browser to see the result.

• The Flask server will be running on http://127.0.0.1:8080.

• When done, stop the MySQL server. (On macOS, run mysql.server stop)

Development

Further details about how to develop the project can be found in the project readme.