diff --git a/README.md b/README.md index e215bc4..ae40525 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,191 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). + + + + + + + +[![Contributors][contributors-shield]][contributors-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![Apache License][license-shield]][license-url] + + + + +
+
+ + Logo + + +

PatSafe

+ +

+ Bridging the gap between doctors and patients for seamless post-discharge care. +
+
+ Visit + · + Report Bug + · + Request Feature +

+
+ + + + +## 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] + + +

(back to top)

+ + + + + ## Getting Started -First, run the development server: +Here are the steps to run the project locally if you want to develop your own project. -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +### Prerequisites -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +* pnpm + ```sh + pnpm self-update + ``` -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. +### Installation -## Learn More +1. Fork the repository and set it up as a project on Vercel or another hosting platform -To learn more about Next.js, take a look at the following resources: +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 + ``` -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! -## Deploy on Vercel -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. + + + + +## License + +Distributed under the Apache 2.0 License. See `LICENSE.txt` for more information. + + +* [Best README Template](https://github.com/othneildrew/Best-README-Template) + +

(back to top)

+ + + + + + + +[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://huggingface.co/](https://openai.com/)