Making communication easier for Hospitals and Patients' Families
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.
For the corresponding front-end (React) repository, visit: MediRepo Web Repository
Experience the live demo application by visiting: MediRepo Demo
Access our comprehensive API documentation on Postman:
- Create a hospital account using our API.
- Utilize our endpoint to submit daily medical bulletins.
- 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.
- Access the user-friendly interface of MediRepo Web to view medical reports.
- Fork the project and clone it to your local computer:
git clone git@github.com:<your-user-name>/medirepo.git- Install required libraries (refer to
.tool-versionsfile for version specifications):
mix deps.get-
Ensure that Postgres is running.
-
Set up the database:
mix ecto.setup-
Use the
.env-samplefile 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). -
Run the project:
iex -S mix phx.serverSee 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!
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.
🎃 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.
If you have any feedback, please reach out to me at andrgab@gmail.com
Made with 💜
Contributors image made with contrib.rocks.