198 lines
12 KiB
Markdown
198 lines
12 KiB
Markdown
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
|
||
<a id="readme-top"></a>
|
||
<!--
|
||
*** Thanks for checking out the Best-README-Template. If you have a suggestion
|
||
*** that would make this better, please fork the repo and create a pull request
|
||
*** or simply open an issue with the tag "enhancement".
|
||
*** Don't forget to give the project a star!
|
||
*** Thanks again! Now go create something AMAZING! :D
|
||
-->
|
||
|
||
|
||
|
||
<!-- PROJECT SHIELDS -->
|
||
<!--
|
||
*** I'm using markdown "reference style" links for readability.
|
||
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
||
*** See the bottom of this document for the declaration of the reference variables
|
||
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
||
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
||
-->
|
||
[![Contributors][contributors-shield]][contributors-url]
|
||
[![Stargazers][stars-shield]][stars-url]
|
||
[![Issues][issues-shield]][issues-url]
|
||
[![Apache License][license-shield]][license-url]
|
||
|
||
|
||
|
||
<!-- PROJECT LOGO -->
|
||
<br />
|
||
<div align="center">
|
||
<a href="https://github.com/GamerBoss101/HoyaHax2025">
|
||
<img src="/public/HoyaHax2025-icon.svg" alt="Logo" width="80" height="80">
|
||
</a>
|
||
|
||
<h3 align="center">PatSafe</h3>
|
||
|
||
<p align="center">
|
||
Bridging the gap between doctors and patients for seamless post-discharge care.
|
||
<br />
|
||
<br />
|
||
<a href="https://www.patsafe.co">Visit</a>
|
||
·
|
||
<a href="https://github.com/GamerBoss101/HoyaHax2025/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
|
||
·
|
||
<a href="https://github.com/GamerBoss101/HoyaHax2025/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<!-- ABOUT THE PROJECT -->
|
||
## About the Project
|
||
|
||
PatSafe is a web-based application that connects discharged patients with their doctors for post-discharge care. It features a doctor’s dashboard where they can update patient information, provide medication instructions, and track patient progress. Patients can report their symptoms, recovery status, and medication adherence, which is then updated in real time for their doctor to review. Additionally, PatSafe includes an AI-powered chatbot that allows patients to ask medical questions and report symptoms, helping doctors get insights into the patient’s condition remotely. The chatbot also aids in tracking medication adherence and offering information for diagnoses and prescriptions.
|
||
|
||
### How does it work?
|
||
|
||
PatSafe was built using **Next.js** and **React.js** for the frontend, while the backend is powered by **MongoDB** and **Clerk** for authentication. The platform utilizes APIs for real-time updates and features such as medication tracking and symptom reporting. We integrated a chatbot powered by **Hugging Face models** for natural language processing, allowing users to interact conversationally and gather helpful medical information.
|
||
|
||
|
||
|
||
|
||
### Built With
|
||
|
||
* [![Next.js][Next.js]][Next-url]
|
||
* [![React][React.js]][React-url]
|
||
* [![Tailwind][Tailwind]][Tailwind-url]
|
||
* [![Clerk][Clerk]][Clerk-url]
|
||
* [![MongoDB][MongoDB]][MongoDB-url]
|
||
* [![HuggingFace][HuggingFace]][HuggingFace-url]
|
||
* [![OpenAI][OpenAI]][OpenAI-url]
|
||
* [![LangChain][LangChain]][LangChain-url]
|
||
* [![Friendli][Friendli]][Friendli-url]
|
||
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||
|
||
|
||
|
||
|
||
<!-- GETTING STARTED -->
|
||
## Getting Started
|
||
|
||
Here are the steps to run the project locally if you want to develop your own project.
|
||
|
||
### Prerequisites
|
||
|
||
* pnpm
|
||
```sh
|
||
pnpm self-update
|
||
```
|
||
|
||
|
||
### Installation
|
||
|
||
1. Fork the repository and set it up as a project on Vercel or another hosting platform
|
||
|
||
2. Install packages
|
||
```sh
|
||
pnpm install
|
||
```
|
||
|
||
3. You can run the website locally with
|
||
```sh
|
||
npm run dev
|
||
```
|
||
or, if hosting on Vercel, with
|
||
```sh
|
||
vercel dev
|
||
```
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!-- LICENSE -->
|
||
## License
|
||
|
||
Distributed under the Apache 2.0 License. See `LICENSE.txt` for more information.
|
||
|
||
|
||
* [Best README Template](https://github.com/othneildrew/Best-README-Template)
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||
|
||
|
||
|
||
|
||
|
||
<!-- MARKDOWN LINKS & IMAGES -->
|
||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||
[contributors-shield]: https://img.shields.io/github/contributors/GamerBoss101/HoyaHax2025.svg?style=for-the-badge
|
||
[contributors-url]: https://github.com/GamerBoss101/HoyaHax2025/graphs/contributors
|
||
[forks-shield]: https://img.shields.io/github/forks/GamerBoss101/HoyaHax2025.svg?style=for-the-badge
|
||
[forks-url]: https://github.com/GamerBoss101/HoyaHax2025/network/members
|
||
[stars-shield]: https://img.shields.io/github/stars/GamerBoss101/HoyaHax2025.svg?style=for-the-badge
|
||
[stars-url]: https://github.com/GamerBoss101/HoyaHax2025/stargazers
|
||
[issues-shield]: https://img.shields.io/github/issues/GamerBoss101/HoyaHax2025.svg?style=for-the-badge
|
||
[issues-url]: https://github.com/GamerBoss101/HoyaHax2025/issues
|
||
[license-shield]: https://img.shields.io/github/license/GamerBoss101/HoyaHax2025.svg?style=for-the-badge
|
||
[license-url]: https://github.com/GamerBoss101/HoyaHax2025/blob/master/LICENSE.txt
|
||
[linkedin-shield]: https://img.shields.io/badge/LinkedIn-0A66C2.svg?style=for-the-badge&logo=linkedin&logoColor=white
|
||
[linkedin-url-joseph]: https://linkedin.com/in/joseph-j-helfenbein
|
||
[product-screenshot]: images/screenshot.png
|
||
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
|
||
[Next-url]: https://nextjs.org/
|
||
[React.js]: https://img.shields.io/badge/React.js-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
|
||
[React-url]: https://reactjs.org/
|
||
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
|
||
[Vue-url]: https://vuejs.org/
|
||
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
|
||
[Angular-url]: https://angular.io/
|
||
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
|
||
[Svelte-url]: https://svelte.dev/
|
||
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
|
||
[Laravel-url]: https://laravel.com
|
||
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
|
||
[Bootstrap-url]: https://getbootstrap.com
|
||
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
|
||
[JQuery-url]: https://jquery.com
|
||
[Expo]: https://img.shields.io/badge/expo-000000?style=for-the-badge&logo=expo&logoColor=white
|
||
[Expo-url]: https://expo.dev/
|
||
[Flask]: https://img.shields.io/badge/flask-4590A1?logo=flask&style=for-the-badge&logoColor=white
|
||
[Flask-url]: https://flask.palletsprojects.com/en/3.0.x/
|
||
[JavaScript]: https://img.shields.io/badge/javascript-yellow?logo=javascript&style=for-the-badge&logoColor=white
|
||
[JavaScript-url]: https://developer.oracle.com/languages/javascript.html
|
||
[ThreeJS]: https://img.shields.io/badge/three.js-black?logo=three.js&style=for-the-badge&logoColor=white
|
||
[ThreeJS-url]: https://threejs.org/
|
||
[TypeScript]: https://img.shields.io/badge/typescript-3178C6?logo=typescript&style=for-the-badge&logoColor=white
|
||
[TypeScript-url]: https://www.typescriptlang.org/
|
||
[Python]: https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white
|
||
[Python-url]: https://www.python.org/
|
||
[Amazon-RDS]: https://img.shields.io/badge/amazon%20rds-527FFF?style=for-the-badge&logo=amazon%20rds&logoColor=white
|
||
[Amazon-RDS-url]: https://aws.amazon.com/rds/
|
||
[Cloudflare]: https://img.shields.io/badge/cloudflare%20workers-F38020?style=for-the-badge&logo=cloudflare%20workers&logoColor=white
|
||
[Cloudflare-url]: https://workers.cloudflare.com/
|
||
[Vercel]: https://img.shields.io/badge/vercel-000000?logo=vercel&style=for-the-badge&logoColor=white
|
||
[Vercel-url]: https://www.vercel.com/
|
||
[Supabase]: https://img.shields.io/badge/supabase-3FCF8E?logo=supabase&style=for-the-badge&logoColor=white
|
||
[Supabase-url]: https://supabase.com/
|
||
[Clerk]: https://img.shields.io/badge/clerk-6C47FF?logo=clerk&style=for-the-badge&logoColor=white
|
||
[Clerk-url]: https://clerk.com/
|
||
[Tailwind]: https://img.shields.io/badge/tailwind%20css-06B6D4?logo=tailwindcss&style=for-the-badge&logoColor=white
|
||
[Tailwind-url]: https://tailwindcss.com/
|
||
[MongoDB]: https://img.shields.io/badge/mongodb-47A248?logo=mongodb&style=for-the-badge&logoColor=white
|
||
[MongoDB-url]: https://www.mongodb.com/
|
||
[HuggingFace]: https://img.shields.io/badge/huggingface-FFD21E?logo=huggingface&style=for-the-badge&logoColor=white
|
||
[HuggingFace-url]: https://huggingface.co/
|
||
[OpenAI]: https://img.shields.io/badge/openai%20api-412991?logo=openai&style=for-the-badge&logoColor=white
|
||
[OpenAI-url]: https://openai.com/
|
||
[LangChain]: https://img.shields.io/badge/langchain-1C3C3C?logo=langchain&style=for-the-badge&logoColor=white
|
||
[LangChain-url]: https://www.langchain.com/
|
||
[Friendli]: https://img.shields.io/badge/FriendliAI-ffffff.svg?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCI+PHBhdGggZD0iTTMuNjgyNSA3LjM4NzVDNS43MTYyOSA3LjM4NzUgNy4zNjUgNS43MzM3NSA3LjM2NSAzLjY5Mzc1QzcuMzY1IDEuNjUzNzUgNS43MTYyOSAwIDMuNjgyNSAwQzEuNjQ4NzEgMCAwIDEuNjUzNzUgMCAzLjY5Mzc1QzAgNS43MzM3NSAxLjY0ODcxIDcuMzg3NSAzLjY4MjUgNy4zODc1WiIgZGF0YS1zZW50cnktZWxlbWVudD0icGF0aCIgZGF0YS1zZW50cnktc291cmNlLWZpbGU9InByb2R1Y3RzLnRzeCI+PC9wYXRoPjxwYXRoIGQ9Ik0zLjY4MjUgMjRDNS43MTYyOSAyNCA3LjM2NSAyMi4zNDYzIDcuMzY1IDIwLjMwNjNDNy4zNjUgMTguMjY2MyA1LjcxNjI5IDE2LjYxMjUgMy42ODI1IDE2LjYxMjVDMS42NDg3MSAxNi42MTI1IDAgMTguMjY2MyAwIDIwLjMwNjNDMCAyMi4zNDYzIDEuNjQ4NzEgMjQgMy42ODI1IDI0WiIgZGF0YS1zZW50cnktZWxlbWVudD0icGF0aCIgZGF0YS1zZW50cnktc291cmNlLWZpbGU9InByb2R1Y3RzLnRzeCI+PC9wYXRoPjxwYXRoIGQ9Ik0xMC4zNTc1IDcuMjAwMDVDMTAuNjQyNSA3LjE0NzU1IDExLjAzNjMgNy4wOTg4IDExLjUwNSA3LjA4NzU1SDEzLjU0NUMxNC43MjYzIDcuMDg3NTUgMTUuNjg2MyA2LjEyNzU1IDE1LjY4NjMgNC45NDYzVjIuNDQxM0MxNS42ODYzIDEuMjYwMDUgMTQuNzI2MyAwLjMwMDA0OSAxMy41NDUgMC4zMDAwNDlIMTEuMDU4OEM5Ljg3NzU1IDAuMzAwMDQ5IDguOTE3NTUgMS4yNjAwNSA4LjkxNzU1IDIuNDQxM0w4LjgzODggMy45MjYzQzguODIwMDUgNC4xODUwNSA4Ljc4NjMgNC40OTI1NSA4LjcxODggNC44MjYzQzguNTgwMDUgNS41MTI1NSA4LjM0MDA1IDYuMDA3NTUgOC4yMzEzIDYuMjA2M0M4LjIzMTMgNi4yMDYzIDcuOTA1MDUgNi44MzI1NSA3LjQ3NzU1IDcuMjcxM0M3LjMyMzggNy40MzI1NSA3LjE1MTMgNy41Nzg4IDcuMTUxMyA3LjU3ODhDNy4wODM4IDcuNjMxMyA3LjAxMjU1IDcuNjkxMyA2LjkzMDA1IDcuNzU4OEM2LjE4MzggOC4zMTc1NSA1LjM5NjMgOC40OTc1NSA1LjE0ODggOC41NDYzQzQuODYzOCA4LjYwNjMgNC4yMDc1NSA4LjYxMzggMy45NDEzIDguNjIxM0gyLjQ0MTNDMS4yNjAwNSA4LjYyMTMgMC4zMDAwNDkgOS41ODEzIDAuMzAwMDQ5IDEwLjc2NjNWMTMuMjY3NUMwLjMwMDA0OSAxNC40NTI1IDEuMjYwMDUgMTUuNDEyNSAyLjQ0MTMgMTUuNDEyNUg0Ljk4NzU1QzYuMTYxMyAxNS40MTI1IDcuMTI4OCAxNC40NDUgNy4xMjg4IDEzLjI2NzVWMTEuNDc1QzcuMTEwMDUgMTAuODU2MyA3LjE0NzU1IDkuNzAxMyA3LjY5NTA1IDguOTI4OEM4LjAzNjMgOC40NDg4IDguNTc2MyA4LjAyMTMgOC42NzAwNSA3Ljk1MDA1QzguODE2MyA3LjgzNzU1IDkuMDgyNTUgNy42MzEzIDkuNDY4OCA3LjQ2MjU1QzkuNTU1MDUgNy40MjEzIDkuODI4OCA3LjMxNjMgMTAuMzU3NSA3LjIxNTA1VjcuMjAwMDVaIiBkYXRhLXNlbnRyeS1lbGVtZW50PSJwYXRoIiBkYXRhLXNlbnRyeS1zb3VyY2UtZmlsZT0icHJvZHVjdHMudHN4Ij48L3BhdGg+PHBhdGggZD0iTTIxLjkzMzcgMC4zMDAwNDlIMTkuMzEyNUMxOC4xNjUgMC4zMDAwNDkgMTcuMjM4NyAxLjIyNjMgMTcuMjM4NyAyLjM3MzhWNC4xNDAwNUMxNy4yMzg3IDQuMTQwMDUgMTcuMjM4NyA1LjM2NjMgMTYuOTM4NyA2LjI4MTNDMTYuNjIgNy4xODg4IDE1LjgwNjIgOC4wMDYzIDE0Ljk5MjUgOC4zMDYzQzE0LjA0IDguNjUxMyAxMi45MjYyIDguNjA2MyAxMi4zNiA4LjYwNjNIMTAuNzY2MkM5LjYyNjIgOC42MDYzIDguNjk5OTUgOS41MzI1NSA4LjY5OTk1IDEwLjY4VjEzLjMxMjVDOC42OTk5NSAxNC40NiA5LjYyNjIgMTUuMzg2MyAxMC43NjYyIDE1LjM4NjNIMTMuMzk1QzE0LjUzNSAxNS4zODYzIDE1LjQ2MTIgMTQuNDYgMTUuNDYxMiAxMy4zMTI1TDE1LjQ4IDEyLjIxMzhDMTUuNDY1IDExLjgwODggMTUuNTA2MiAxMC45Njg4IDE1LjcwNSAxMC4zNTM4QzE1Ljc4IDEwLjEyODggMTUuOTI2MiA5LjcwODggMTYuMjYgOS4yNDc1NUMxNi41IDguOTIxMyAxNi43MzI1IDguNzE1MDUgMTYuOTcyNSA4LjQ5MzhDMTcuNDA3NSA4LjEwNzU1IDE3Ljc3MTIgNy44Nzg4IDE3Ljg3MjUgNy44MjYzQzE4LjA5MzcgNy42OTEzIDE4LjQ3MjUgNy40NjYzIDE5LjAxMjUgNy4zMDEzQzE5LjQ5MjUgNy4xNTUwNSAxOS44NTI1IDcuMTI4OCAyMC40Njc1IDcuMDg3NTVDMjAuODI3NSA3LjA2MTMgMjEuMzI2MiA3LjA0NjMgMjEuOTI2MiA3LjA4MDA1QzIzLjA3MzcgNy4wODAwNSAyNCA2LjE1MzggMjQgNS4wMDYzVjIuMzczOEMyNCAxLjIyNjMgMjMuMDczNyAwLjMwMDA0OSAyMS45MjYyIDAuMzAwMDQ5SDIxLjkzMzdaIiBkYXRhLXNlbnRyeS1lbGVtZW50PSJwYXRoIiBkYXRhLXNlbnRyeS1zb3VyY2UtZmlsZT0icHJvZHVjdHMudHN4Ij48L3BhdGg+PC9zdmc+&style=for-the-badge
|
||
[Friendli-url]:https://friendli.ai/
|