This repository uses a monorepo structure. Each package has its own code in its respective folder in packages/.
app- The static frontend website that patients use to join their telehealth visit and providers use to answer.zambdas- The application's back end endpoints, deployed on the zapEHR platform.
Each package has its own README explaining in more detail its purpose, as well as how to run locally and deploy (if applicable).
- Install nvm.
- Use nvm to install node 18:
nvm install 18. - Use nvm to make node 18 your default node:
nvm alias default 18.
To keep our code easily readable, there is a rigorous ESLint configuration enforced. VSCode is recommended for coding because it provides an excellent live linting experience.
To get linting in VSCode:
- Install the ESLint Extension.
- Always open the repo from its root. This allows the extension to detect the
.eslintrc.jsonfile which specifies the linter configuration. - (Optional) Use the VSCode workspace for a helpful alternative organization of the project in the VSCode 'Explorer', which most developers find useful. This can be opened in 2 ways:
- Open the file in VS Code. Click on the "Open Workspace" button in the bottom-right.
code .vscode/Ottehr.code-workspace
The easiest way to get started is to use the brew command:
brew install pnpmOtherwise, you can install it onto your machine using the documentation.
Run pnpm i at the top level to install dependencies for all packages in the monorepo. Then run pnpm start to start all packages locally.
pnpm <script name>If a script is environment specific, use:
pnpm <script name>:<env>Builds all packages using the build script.
Lints all packages using ESLint.
Environment specific: local, dev, dev2, testing, staging.
Starts all packages. If the env is excluded, defaults to local.
Interactively updates all dependencies to their latest versions, respecting ranges specified in package.json.