Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrissiku/p2doc-healthcare
https://github.com/chrissiku/p2doc-healthcare
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/chrissiku/p2doc-healthcare
- Owner: Chrissiku
- License: mit
- Created: 2023-11-22T20:23:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T11:13:50.000Z (3 months ago)
- Last Synced: 2024-11-03T16:39:51.167Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://p2doc-healthcare-rho.vercel.app/
- Size: 8.49 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🩺 P2Doc Healthcare
> P2Doc is a platform that leverages the power of Web5 to ensure a secure sharing of medical records between patients and doctors, hence the name P2Doc, signifying Patient-to-Doctor interaction
## 🪧 Problem statement
Numerous individuals have faced unfortunate consequences due to the absence of a secure means through which their medical records can be confidentially shared. Maintaining the confidentiality of medical information, even when shared over the internet, remains a critical concern. When examining previous web technologies, such as Web2 and Web3, which are centralized, it becomes apparent that users' data is stored by third-party entities, leaving it vulnerable to exposure by malicious actors. Hence, we conceived the idea of concealing the sharing of medical records between doctors and patients by harnessing the power of decentralized technology (Web5).
## ⚙ Key features
The application offers the following key features:
- **Profile Creation:**
Both doctors and patients can easily create and manage their profiles based on their user type.
- **Doctor Dashboard:**
Doctors have access to a dedicated dashboard where they can view incoming requests from onboarded patients.
- **Appointment Management:**
Doctors can efficiently manage appointments, including viewing recently booked appointments.
- **Medical Record Management:**
Doctors can write and manage medical records securely within the platform.
- **Patient Appointment Booking:**
Patients can conveniently book appointments with their preferred doctors through the platform.
- **Medical Record Access:**
Patients can easily access and view their medical records, ensuring transparency and convenience.
## 🚦 Getting Started
To get a local copy up and running, follow these steps.
### Prerequisites
To run this project you need:
- Node.js and npm:
Ensure that Node.js, a JavaScript runtime, is installed on your machine.
npm (Node Package Manager) is typically included with Node.js.
- Text Editor:
Choose a preferred text editor for code editing. Popular choices include Visual Studio Code, Sublime Text, or Atom.
- Web Browser:
Have a modern web browser installed (e.g., Google Chrome, Mozilla Firefox, or Microsoft Edge) to launch and interact with the application.
## 🗝️ Set up
Step 1: Clone this repository to your desired path:
```
git clone https://github.com/Chrissiku/p2doc-healthcare.git
```
Step 2: Change the directory (dir) to p2doc-healthcare path
```
cd p2doc-healthcare
```
Step 3: Install all the required dependencies (using npm in our case)
```
npm install
```
Step 4: Run the project locally by starting the server
```
npm run dev
```
## 🎲 Configuration
To ensure optimal functionality of the application, create a `.env` file in the root of your repository and add the following variables:
```
VITE_PUBLIC_DID=did:dht:zmuq5prbfsqe4tg5oqf6qprhnjkg7gg73jdfae8gznqn3rpoubho
VITE_PROTOCOL_URL=http://localhost:5173/
```
**Note:**
To generate a token for `VITE_PUBLIC_DID`, navigate to `Web5Context.jsx` file and add the `console.log(did)` statement at the end of the `useEffect` where the `did` is set.
Generate the token from the browser console, and paste the token into your variable.
## 🌎 Deployment
To run the application in a production environment, you can access the live version using the following URL:
- [p2doc healthcare](https://p2doc-healthcare-rho.vercel.app/)
## 👥 Contributors
- **👤 Christian Siku**
- **👤 Gina Beki**
- **👤 Sunday Peter**
- **👤 Hussein Yusuf**
## 🪪 License
This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details.