SOFTENG761 - Team1

This project aims to provide Medical and Health Science students at the University of Auckland with a tool that supports interactive and immersive education through virtual patient scenarios.

This project is associated with The University of Auckland SOFTENG 761.

Live deployments

Frontend: https://vps-uoa.netlify.app

Wiki: https://vps-uoa-wiki.netlify.app

Backend: https://virtual-patient-system.herokuapp.com/

| CI | Status | | ——————- | ——– | | ESLint | | | Prettier | | | Tests | | | Contributors | |

Setup & Run

Tool versions

• Ideally you should use the following versions to make this repository work.
• node v14.17.*
• yarn 1.22.*
• NPM 6.14.*

To set up App

• Run yarn install in the root directory
• Run yarn run init in the root directory (installs dependencies for frontend and backend directories)

To run App

• Run yarn run dev in the root directory to start both frontend and backend environments

Alternative Way to Setup & Run

To set up App

• Open two terminals
• Change directory by running cd frontend and cd backend in each terminal
• Run yarn install in the each terminal

To run App

• Run yarn start in the each terminal

Test and Continuous Integration

• Open terminal and cd frontend or cd backend depending on which folder you are testing
• Run yarn run test to run unit tests;
• Run yarn run lint to lint; Run yarn run lint:fix to fix linting;
• Run yarn run prettier to test for prettier; Run yarn run prettify to fix prettier issues;

File Structure

├── frontend/
│ └── src
│ └── package.json
├── backend/
│ └── src
│ └── package.json
├── wiki/
│ ├── react-movable.md
│ └── ...
├── README.md
├── package.json
└── ...

Wiki documentation

Our wiki is is easily viewable through: https://vps-uoa-wiki.netlify.app

(Note: links to some images are broken due to CORS issues)

Coding Conventions

Commit message

[VPS-000] Your commit message

Branch Name

VPS-000/description-of-the-story

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Lucas Gao 💻	Felix Yang 💻	David Xiao 💻	zyan225 💻	Dong Mei Lim 💻	annithinggoes 💻	Andrew Fei 💻
NatalyMartini 💼 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!