Skip to content

valik94/dRecords

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dRecords

Project Description An online charting application allowing healthcare providers to access patient information and schedule follow-up appointments efficiently. The user can keep track of old entries and register new ones upon a change in the patient's condition. An integrated calendar allows the user to plan tasks and keep track of upcoming events.

Problem Statement Currently, there are few universal tools that allow for charting, diagnosis, medical history, and appointment all on one platform, which leads to greater effort on practitioner and time consumption. To solve the inefficiencies there should be a uniform portal allowing for all of these procedures to happen in one place.

Solution and Product Projects’ value proposition is to allow the practitioner to perform all these functions resulting in a greater time savings and convenience, freeing up their time to allow for actual healthcare rather than administrative duties. Now Valentin will demonstrate our application.

Target audience: Healthcare providers looking for an effective way of documenting their diagnosis and notes as well as keeping track of patients.

User Stories

As a user (healthcare practitioner) I want to

  1. Register
  2. Login
  3. Add patients
  4. See all my patients on my main page
  5. Be able to search patients by name
  6. See my calendar
  7. Be able to book an appointment with a patient
  8. Send a notification to the patient via phone or email
  9. Open a patient profile and see all relevant information
  10. Able to chart on patient’s change in condition or consultation
  11. Able to see previous notes left on this patient

User Diagram with Mermaid

journey
	title dRecords is a practitioner web-application to manage patients their medical records and appointments
	section Practitioner using drecords web-app
		logs-in & views my patients list: 1: Practitioner
		choose particular patient from list: 3: Practitioner
		chart, read med info & set diagnosis: 5: Practitioner, Patient
		book appointment, email notification: 5: Practitioner, Patient
	section Patient check their email
		receives email: 5: Patient
		appointment details or cancels by call: 2: Practitioner, Patient
	section Patients visits appointment
		is able to chart & update notes on patient: 2: Practitioner
		updates database, account logs out: 5: Patient
Loading

USER README

  1. Fork and/or clone the repo on your local machine
  2. Change directory into the repo folder.
  3. Open 2 terminals, on the first one - change into the client folder and on the second one change into the server folder
  4. run the command npm install to install development dependencies for the program to work. NOTE: run this command in both terminals (client and server)
  5. You must have posgress installed to run the database, if you dont, run the following command to install it $ npm install pg.
  6. Inside the server folder run the command npm run db:reset to ensure you create and seed the database.
  7. Open another terminal (terminal #3), go into the server directory and run postgress using the command psql.
  8. Create the database using the \c __databasename__ command.
  9. to exit psql run exit command.
  10. Try to rerun the command npm run db:reset to recreate the database if it didnt work earlier.
  11. Re-run npm run in both terminal 1 (client) and terminal 2 (server).
  12. Finally, navigate to http://localhost:3000/ to go to the homepage of the app! We hope you enjoy using it! Please feel free to reach out to us via github for any feedback and improvement suggestions.

DEVELOPER GUIDE / ADVANCED USER STRETCH USER Stories

  1. Filter list of patients by latest/earlier viewed
  2. Be able to fill a patient medical history form
  3. Chat system for practitioners to communicate

Project Git Workflow

NEVER code on Main!

Create Feature Branches git checkout -b feature/my-feature

Main branch is your production branch, never directly work on it!

Starting a new branch

  1. git checkout main (Start new branches from the main branch)
  2. git pull (Make sure you have the most recent version)

Working on the branch 3. git checkout feature/my-feature (Make your feature) 4. git add & git commit (Commit often with meaningful messages !) 5. git push (So it's not only local)

Merging main in the BRANCH 6. git checkout main (To update it) 7. git pull 8. git checkout feature/my-feature (Back to your feature) 9. git merge main 10. Fix conflicts if any 11. git commit (commit the merge) 12. git push (So it's not only local)

Merging the branch back in MAIN 13. git checkout main (To merge your branch) 14. git merge feature/my-feature 15. Should not be any conflict since you cleaned them in the branch first 16. git commit (commit the merge) 17. git push (So it's not only local)

NEW Workflow

  1. Step 1 - git pull origin main Make sure to pull all recent changes to main to start the branch-off process.

  2. Step 2 - Add a branch To add a branch

git checkout -b branchname
  1. Step 3 - work on feature branch Commit as OFTEN as you can! Commits really matter. Don't do everything in 1 commit.

  2. Feature complete!

Now that you are done, and everything has been commited, push the BRANCH into github.com

git push origin_branchname_

On github, create a pull request bym clicking pull requests button, then clicking the new pull request button on the apge. Pick your branch then fill out the form to generate pull request.

#this already checks for conflicts for me #this also shows all file changes made

If you have a merge conflict github will tell you

  • There are 2 was to fix it, 1, github will five you tools (bad way)
  • Switch to main, pull all changes, switch back to your branch, MERGE main into your branch and fix conflicts

Once you fixed them, push the branch back out, and your pull request will be updated.

Merging pull requests

Once reviewed and approved by a team member, merge the pull request by clicking green merge pull request button. Now everything will be added to main branch.

Releases

No releases published

Packages

No packages published