Releases: Capstone-Projects-2024-Spring/project-phillygpt
Releases · Capstone-Projects-2024-Spring/project-phillygpt
v3.0.0
What's Changed
- fixed gitignore. by @zyij99 in #72
- Updated Documentation Based on Feedback 1 From TA by @alishahidd in #73
- Updated documentation and README by @alishahidd in #75
- Reprompt page loading fix & Reprompt suggestions by @zyij99 in #74
- Changed Typescript to javascript and created .env for google maps api… by @princegeutler in #76
- Add ChatGPT Map Info by @princegeutler in #78
- dockerize the project. see description before merge. by @zyij99 in #77
- Cleaned up Map Code by @princegeutler in #79
Full Changelog: v2.0.1...v3.0.0
v2.0.1
What's Changed
- Princegeutler map change by @princegeutler in #65
- Update app.tsx by @princegeutler in #67
- Passing sql aidan by @princegeutler in #68
- Added line that was taken out during merge. by @AidanScharnikow in #69
- Display result by @AidanScharnikow in #70
- Last minute pull by @princegeutler in #71
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
ORsource 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
ornpm 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
What's Changed
- Added to requirements.txt by @andrewto30 in #59
- Adding Map to Main page and update yarn lock by @princegeutler in #62
- Prompting Testing by @AidanScharnikow in #61
- Display and prompt by @AidanScharnikow in #63
Full Changelog: v1...v2.0.0
v1.0.0
What's Changed
- Update system-overview.md by @andrewto30 in #1
- Update use-case-descriptions.md by @alishahidd in #3
- Update general-requirements.md & general project README & added collaborators. by @zyij99 in #4
- Added Block Diagram, Functional and Nonfunctional Requirements by @zyij99 in #5
- Update use-case-descriptions.md by @andrewto30 in #7
- Update use-case-descriptions.md by @andrewto30 in #14
- Update system-overview.md by @andrewto30 in #13
- Update features-and-requirements.md by @andrewto30 in #12
- fix-mermaid by @leekd99 in #16
- set up flask and openai api. see description for more info by @zyij99 in #15
- Update design.md by @andrewto30 in #17
- Update version-control.md by @andrewto30 in #19
- Update development-environment.md by @andrewto30 in #18
- Added system architecure diagram by @princegeutler in #20
- Created and added Use Case Sequence Diagrams by @alishahidd in #21
- Update design.md by @andrewto30 in #22
- Convert original implementation to RESTful API with endpoints for information ('/') and user input processing ('process_input'). by @zyij99 in #23
- refactored the code further. by @zyij99 in #25
- Add Api Spec by @princegeutler in #26
- Sequence Diagram Updates by @alishahidd in #24
- Documentation Modifications by @alishahidd in #27
- added pytest testing for index and process_input endpoints by @zyij99 in #28
- Feature unit testing by @andrewto30 in #29
- Create python-app.yml by @andrewto30 in #30
- Andrewto30 patch 1 by @andrewto30 in #32
- added a failure test to test actions by @andrewto30 in #33
- Passing all test case for actions by @andrewto30 in #34
- Unit test documentation by @zyij99 in #36
- added missing param in test_post_user_input for docs by @zyij99 in #37
- Test documents by @andrewto30 in #38
- Updated Use Case 3 with new sequence diagram by @alishahidd in #39
- create reactapp by @alishahidd in #40
- Created a navbar with redirection links to home, documentation, and github repo by @zyij99 in #41
- Added prompt bar with enter button along with styling to match figma … by @andrewto30 in #42
- Display area under search bar. by @AidanScharnikow in #43
- added light/dark mode as well as refactored code into components. by @zyij99 in #45
- Examplecomponents by @alishahidd in #46
- established routing for response and reprompt pages. by @zyij99 in #47
- Styling changes by @AidanScharnikow in #48
- fixed bug with light/dark mode, updated page to reflect new design for light mode & added minor changes for better visibility. by @zyij99 in #49
- Feature user story 3 by @andrewto30 in #50
- removed comments by @andrewto30 in #51
- Table organization by @AidanScharnikow in #52
- updated requirements.txt by @zyij99 in #53
- Loading component should render while waiting to fetch data and connected search bar to backend. by @zyij99 in #55
- updated package-lock by @zyij99 in #56
- Adding map by @princegeutler in #57
- Feature example prompts by @andrewto30 in #58
- OpenAI calls from the REST API now connected to frontend and shows in the SQL section of the response box by @zyij99 in #60
New Contributors
- @andrewto30 made their first contribution in #1
- @alishahidd made their first contribution in #3
- @zyij99 made their first contribution in #4
- @leekd99 made their first contribution in #16
- @princegeutler made their first contribution in #20
- @AidanScharnikow made their first contribution in #43
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
ORsource 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
ornpm 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.