Skip to content

Releases: Capstone-Projects-2024-Spring/project-phillygpt

v3.0.0

22 Apr 17:01
fa4bd1d
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2.0.1...v3.0.0

v2.0.1

12 Apr 17:27
d88ae75
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2.0.0...v2.0.1

How to run this project

  • Requirements: Python, JavaScript, npm, yarn
  • API keys: OpenAI key, Google maps api key
  • AWS EC2 instance, mysql db hosted within EC2 instance (we're using mariadb)
  • create python virtual enviornment on MacOS: python3 -m venv venv activate: venv/bin/activate OR source venv/bin/activate OR for windows: python -m venv <path> ./venv/Scripts/activate
  • Install backend dependencies: $pip install -r requirements.txt
  • React setup: npm install or npm ci
  • to run react setup in development: npm start
  • running flask backend (dev): python3 server.py
  • If you're having trouble with @react-google-maps/api try using yarn add @react-google-maps/api
  • If you're having trouble with npm try: npm install --force
  • you will need a .env file with the following: OPENAI_API_KEY, SSH_HOST, SSH_PORT, SSH_USERNAME, SSH_PRIVATE_KEY (Note: this is the path to the .pem file for EC2 instance), MYSQL_HOST, MYSQL_PORT, MYSQL_USERNAME, MYSQL_PASSWORD, MYSQL_DB
  • You will also need the .cer/.pem file to access EC2 instance.

v2.0.0

12 Apr 17:12
2d524c0
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1...v2.0.0

v1.0.0

08 Apr 18:20
2846f20
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: https://github.com/Capstone-Projects-2024-Spring/project-phillygpt/commits/v1

Jira Stories Completed

How to run this project

  • Requirements: Python, JavaScript, npm, yarn
  • API keys: OpenAI key, Google maps api key
  • AWS EC2 instance, mysql db hosted within EC2 instance (we're using mariadb)
  • create python virtual enviornment on MacOS: python3 -m venv venv activate: venv/bin/activate OR source venv/bin/activate OR for windows: python -m venv <path> ./venv/Scripts/activate
  • Install backend dependencies: $pip install -r requirements.txt
  • React setup: npm install or npm ci
  • to run react setup in development: npm start
  • running flask backend (dev): python3 server.py
  • If you're having trouble with @react-google-maps/api try using yarn add @react-google-maps/api
  • If you're having trouble with npm try: npm install --force
  • you will need a .env file with the following: OPENAI_API_KEY, SSH_HOST, SSH_PORT, SSH_USERNAME, SSH_PRIVATE_KEY (Note: this is the path to the .pem file for EC2 instance), MYSQL_HOST, MYSQL_PORT, MYSQL_USERNAME, MYSQL_PASSWORD, MYSQL_DB
  • You will also need the .cer/.pem file to access EC2 instance.