AndrGab / MediRepo

MediRepo API helps Hospitals with Daily Medical Reports - for COVID19 patients with restricted visits

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo

Elixir/Phoenix API for Daily Medical Reports

Making communication easier for Hospitals and Patients' Families

GitHub top language Made by codecov elixir ci GitHub

Introduction

MediRepo is an Elixir/Phoenix API designed to facilitate communication between hospitals and patients' families by sharing Daily Medical Reports. In the midst of COVID-19 restrictions on hospital visits, this project aims to bridge the gap and provide essential medical information to concerned families.

Front End

For the corresponding front-end (React) repository, visit: MediRepo Web Repository

Live Demo

Experience the live demo application by visiting: MediRepo Demo

How to Use MediRepo

For Hospitals

API Documentation

Access our comprehensive API documentation on Postman: Postman Documentation

  1. Create a hospital account using our API.
  2. Utilize our endpoint to submit daily medical bulletins.
  3. Share the Patient Code and Attendance Code (password) with the patient's family.

By using the same Patient Code and Attendance Code, only the latest medical report will be shared automatically. Integrate MediRepo API with your main application to streamline medical report submission, or use the web application for manual bulletin creation and editing.

For Patients' Families

  1. Access the user-friendly interface of MediRepo Web to view medical reports.

Local Setup Guide

  1. Fork the project and clone it to your local computer:
git clone git@github.com:<your-user-name>/medirepo.git
  1. Install required libraries (refer to .tool-versions file for version specifications):
mix deps.get
  1. Ensure that Postgres is running.

  2. Set up the database:

mix ecto.setup
  1. Use the .env-sample file to create your environment variables. Configure your SMTP server username and password. If you don't have an SMTP server, you can create one with any name. In the development environment, you can access sent emails using Bamboo viewer (localhost:4000/sent_emails).

  2. Run the project:

iex -S mix phx.server

Contributing

See you contributing guidelines and our Code of condute.

You can contribute to this project including:

  • new features;
  • architectural improvements;
  • searching bugs;
  • adding test coverage;
  • starring the project ⭐

Feel free to contribute!

HacktoberFest

If you came here for Hacktoberfest:

Celebrate Hacktoberfest by getting involved in the open source community by completing some tasks in this project.

This repository is open to all members of the GitHub community. Any member may contribute to this project without being a collaborator.

What is Hacktoberfest?

🎃 HacktoberFest is digitalocean’s annual event that encourages people to contribute to open source throughout October. Much of modern tech infrastructure—including some of digitalocean’s own products—relies on open-source projects built and maintained by passionate people who often don’t have the staff or budgets to do much more than keeping the project alive. 🎃 HacktoberFest is all about giving back to those projects, sharpening skills, and celebrating all things open source, especially the people that make open source so special.

https://hacktoberfest.com/

Screenshots

Bulletin Example

Feedback

If you have any feedback, please reach out to me at andrgab@gmail.com

Author

Made with 💜

Made by

Contributors

Credits

Contributors image made with contrib.rocks.

About

MediRepo API helps Hospitals with Daily Medical Reports - for COVID19 patients with restricted visits

License:MIT License


Languages

Language:Elixir 97.9%Language:Nix 1.1%Language:Dockerfile 0.8%Language:Shell 0.1%Language:Makefile 0.1%