[VPS-131] VPS Onboarding 2024(1)
Closed this issue · 0 comments
JordanBlenn commented
Description:
AS A: member of the 2024 VPS Development Team
I WANT: to set up a local build
SO THAT: I can edit the code and contribute to the project.
AC's:
- Each member of the dev team has cloned the remote repository and can edit a local copy
- Each member of the dev team is able to run a local build of the repository and can 'play' the Virtual Patient Simulator
- Each member of the dev team is familiar with how the Simulator works
- Each member of the dev team if comfortable with using GitHub (i.e. commits, branches, pull requests)
- Each member of the dev team has added themselves as a contributor to the ReadMe
- Each member of the dev team gains some familiarity with at least one of JS/HTML/CSS
Technical Discussion:
- Most of this will be explained in the Onboarding Documentation, but can be achieved as follows:
- Clone the Github Repository
- Install nvm, node (14.), yarn, and npm.
- Add the .env files to the
frontend
andbackend
folders respectively - in the root directory of the project: run
yarn install
,yarn run init
,yarn run dev
. This should start up a localhost of the codebase (aka the current version of the simulator, which can be played). - Ideally everyone will have completed 1 basic PR by the end of the first sprint
(If this sound foreign to you, don't worry! We will explain in simple terms later 😄 )