Jamva SENG3011 API

Project Description

An API to access disease reports from offical outbreak websites. From thoese reports reformat the infomation to fit our users requirements. A platform that provides one or more of the following functions for an end user interested in epidemics detection. For more information check the following documents: Design Details doc: https://jamva.atlassian.net/wiki/spaces/JAMVA/pages/491521/Design+Details

Management doc: https://jamva.atlassian.net/wiki/spaces/JAMVA/pages/262145/Management+Information

Testing doc: https://jamva.atlassian.net/wiki/spaces/JAMVA/pages/1474561/Testing+Documentation

Swagger API doc: https://app.swaggerhub.com/apis/Jam35/JamvaReal/1.0.0

Run the Project

To install required libraries:

1. pip install -r requirements.txt

To run locally:

1. go into API_SourceCode folder
2. run the following command: "uvicorn main:app --reload"

To run deployed server:

1. go to "SENG3011_Jamva/PHASE_1/"
2. run the following command: "sudo ssh -i "jamvakey.pem" [email protected]"
3. Once connected to virtual machine go to "SENG3011_Jamva/PHASE_1/API_SourceCode"
4. run the following command: "uvicorn main:app --reload"

Public IP: https://3.106.142.227/

version 1 base path: v1/

Credits

Specifications managed by UNSW SENG3011 T1 2022 Team Development Team:

• Jay Patel, [email protected]
• Jesse Merhi, [email protected]
• Vishnu Birudavolu, [email protected]
• Jack Whaling, [email protected]
• Marko Wong, [email protected]

Change log

Changes made to reports between delieverables 1 and 2

1. Management Information has been updated to include software tools alternatives
2. Design Details has been changed to include more design princples, justifications, and has had and update to the overall presentation
3. In other words... implemented feedback from D1 and updated respective reports and documents...