Skip to content

Latest commit

 

History

History
144 lines (90 loc) · 4.78 KB

README.md

File metadata and controls

144 lines (90 loc) · 4.78 KB
Raw

MediRepo Logo

Elixir/Phoenix API for Daily Medical Reports

Streamlining communication between Hospitals and Patients' Families

GitHub top language Made by Coverage CI Status License

🚀 Introduction

MediRepo is an Elixir/Phoenix API that simplifies communication between hospitals and families by sharing daily medical reports. Especially useful during COVID-19 restrictions on hospital visits, it helps keep families informed while reducing the stress of uncertainty.

💻 Front End

Check out the corresponding front-end built with React: MediRepo Web Repository

🌐 Live Demo

Explore the live demo of MediRepo: MediRepo Demo

📚 How to Use MediRepo

🏥 For Hospitals

API Documentation: Access our detailed API documentation on Postman: Postman Documentation

  1. Register a hospital account through the API.
  2. Submit daily medical reports using our endpoints.
  3. Share the Patient Code and Attendance Code (password) with the patient's family.

Families can access the latest report using these codes, ensuring secure and straightforward communication. You can integrate MediRepo API with your main hospital system for automated updates, or use the web interface for manual entry.

👨‍👩‍👧‍👦 For Patients' Families

Use our intuitive interface at MediRepo Web to view the medical reports shared by the hospital.

⚙️ Local Setup Guide

  1. Fork and Clone the repository:

    git clone [email protected]:<your-user-name>/medirepo.git

  2. Install dependencies (refer to .tool-versions for version details):

    mix deps.get

  3. Start PostgreSQL to support the database.

  4. Set up the database:

    mix ecto.setup

  5. Configure environment variables using the .env-sample file, including your SMTP server details for email notifications. During development, view sent emails at localhost:4000/sent_emails using Bamboo viewer.

  6. Run the application:

    iex -S mix phx.server

🤝 Contributing

Check out our Contributing Guidelines and Code of Conduct. You can help by:

  • Adding new features
  • Improving architecture
  • Fixing bugs
  • Expanding test coverage
  • Starring the project ⭐

We welcome your contributions!

🎃 HacktoberFest

Contribute to this project as part of Hacktoberfest!

What is Hacktoberfest?

Hacktoberfest, organized by DigitalOcean, is a month-long celebration encouraging contributions to open-source projects. It’s a great way to give back to the community, sharpen your skills, and support projects that make a difference.

Learn more about Hacktoberfest

📸 Screenshots

Bulletin Example

📬 Feedback

Have any feedback? Feel free to reach out to me at [email protected]

👤 Author

Made with 💜 by Andre Gabriel

LinkedIn

🌟 Contributors

Contributors

🏅 Credits

Contributors image created with contrib.rocks.