Skip to content

Kareem01001011/HeartLog

Repository files navigation

HeartLog

A health monitoring software that logs, manages, and analyzes a patient's vitals.

Notes

This is a prototype that tries to match my image of the full project. But it's not yet at all a finished product. I'm just exploring the development path of the project before starting to work on it to be able to build it properly. Most of the libraries and technologies I've used in this prototype will be gradually replaced with newer and more streamlined things until I'm happy with it, then I'll start again from scratch using the stuff I learned while developing this prototype to build the actual project.

I'm always trying to improve the code, making positive changes to it, and to the project idea in general. I might sometimes go for a long time without updating this repository, but I'm tirelessly working on it locally, behind the scenes.

I'd also recommend checking the CHANGELOG.md file to see all the new changes and features in each update.

Technologies

Reminder: This is just referring to the current state of the prototype, not the full product. It does not reflect what the program would look like after it's done. I'm basically just testing different technologies and learning from them so I would be able to properly build the main program.

  • Javascript as the main programming language, since it allows for cross-compatibility as a web app, so as to not have to port it to multiple different platforms (I'm lazy...).

  • MongoDB as the main database. Chosen mainly for its scalability, since the amount of heart rate & health-related data recorded in it would be huge. It's also because I personally prefer dealing with JSON data instead of SQL...

  • Express.js for the server-side stuff.

  • Chartist for the graphs.

Getting Started

Prerequisites

  • Have Node.js & Git installed on your machine.

Installation

  1. Clone this repository and navigate to the project's directory:
git clone https://github.com/Kareem01001011/HeartLog.git
cd HeartLog
  1. Install the needed libraries:
npm install
  1. Run the project:
node .

This runs the server that receives the requests, fetches the data from the database, then sends it to the client.

  1. Go to https://localhost:3000 and you should see the prototype running.

Got any issues?

If you've faced any problems, try submitting a new issue on this project's GitHub repository, and I'll try as much as I can to help you.

License

This code is available under the GPL-3 license. See the LICENSE file or click here for more info.