Project website: https://calvin-emr.web.app/about-us
The Calvin University Electronic Medical Record (EMR) aims to reproduce enterprise EMR software at a fraction of the cost for the purpose of educating and training aspiring nurses.
The project was generated with Angular CLI version 12.2.6, but has been since upgraded to Angular CLI version 13.3.7.
Before you start writing code for the project, please read the Important section of the documentation. Each of the Important pages details an important aspect about the app: the entire tech stack, the frontend's data flow, and more. Reading these pages will hopefully give you a better sense of how to navigate our app and make changes accordingly.
Additionally, make sure to read up on the section of the EMR you plan to make changes on. For example, if you are looking to change the Nursing Assessment, read the documentation on the Assessment classes (e.g. Genitourinary, Gastrointestinal, etc.) and how they are used to send data to Firestore. The documentation for the classes and functions involved may have important tips on how to use them.
The following section describes how to use the Angular CLI to build, serve, and test the app.
Before you get started, make sure you have the following installed:
The above should install without much issue on Linux and MacOS. If you are running Windows, see the Windows troubleshooting guide.
Notes:
- It is strongly recommended to install nvm to manage different versions of Node.js and npm. As of the time of writing, we use Node v16.15.0 (npm v8.5.5).
- When installing the Angular CLI, you may need to use
sudo npm install -g @angular/cli.
- Clone the application repo to your local machine:
git clone https://github.com/CS396-398-EMR/calvin-emr.git- Enter into the
calvin-emrdirectory:
cd calvin-emr- If you are using nvm, switch Node to v16.15.0:
nvm use v16.15.0- Install all npm packages:
npm install- Serve the application!
ng serveAs mentioned in the Environment Set-Up section, you will need Git, Node.js, npm, and Angular CLI installed to build the project. However, these may not be easy to do on Windows. This section serves as a guide to setting up the environment on Windows.
It is strongly recommended to install nvm to manage different versions of Node.js and npm. As of the time of writing, we use Node v16.15.0 (npm v8.5.5).
On Windows, we will use a similar (but not identical) package to nvm: nvm-windows. You can download the latest release here. Under the desired release, there should be an Assets dropdown. Under this dropdown is a zip file named nvm-setup.zip. Download this file, open it, and run the nvm-setup.exe file inside of it. Follow the installer instructions to configure the installation of nvm-windows on your local machine.
Now you should have access to nvm on the command line! You will now need to download the correct version of nvm. Open the Command Prompt as Administrator. Enter the below line into the command line:
nvm install 16.15.0 && nvm use 16.15.0
You can now close the Administrator Command Prompt. To check that nvm-windows is using the correct version of Node, enter the following into the command line:
nvm current
Verify that the version matches the one below.
v16.15.0
Node and npm are now ready for use in the EMR project!
After installing nvm-windows, you should be able to run the below command in the Command Prompt:
npm install -g @angular/cli
This will install the Angular CLI and any dependencies associated with it.