Skip to content

Commit 97370eb

Browse files
codingwithnshcodingwithnsh
authored
Add files via upload
1 parent 1963e10 commit 97370eb

File tree

2 files changed

+169
-0
lines changed

2 files changed

+169
-0
lines changed

‎LICENSE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Copyright (c) 2024 Naman Shettigar
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, and merge, subject to the following conditions:
7+
8+
1. **No Distribution or Sale Without Permission**:
9+
The Software or any modified version of the Software may not be distributed, sublicensed, or sold, in whole or in part, without prior written permission from the copyright holder.
10+
11+
2. **Inclusion of Copyright Notice**:
12+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
13+
14+
3. **No Warranty**:
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
2+
# Medics Software
3+
4+
## Table of Contents
5+
1. [Introduction](#1-introduction)
6+
2. [Features](#2-features)
7+
3. [System Requirements](#3-system-requirements)
8+
4. [Installation Guide](#4-installation-guide)
9+
5. [Usage Instructions](#5-usage-instructions)
10+
6. [Screenshots](#6-screenshots)
11+
7. [API Reference](#7-api-reference)
12+
8. [Troubleshooting](#8-troubleshooting)
13+
9. [Testing](#9-testing)
14+
10. [Deployment](#10-deployment)
15+
11. [Roadmap](#11-roadmap)
16+
12. [License](#12-license)
17+
13. [Contact](#13-contact)
18+
14. [Contribution Guide](#14-contribution-guide)
19+
15. [FAQs](#15-faqs)
20+
21+
## 1. Introduction
22+
The Medics software is a medical management system designed to help patients and doctors manage medical information effectively. It allows patients to enter their diagnoses, schedule appointments, and provides doctors with an overview of their patients.
23+
24+
## 2. Features
25+
- Patient login and registration
26+
- Doctor login and management
27+
- Diagnosis submission
28+
- Appointment scheduling
29+
- Data stored in Excel format
30+
- User-friendly interface
31+
32+
## 3. System Requirements
33+
- Python 3.7 or higher
34+
- pandas library
35+
- openpyxl library
36+
- Excel installed (for viewing Excel files)
37+
38+
## 4. Installation Guide
39+
Follow these steps to install and run the Medics software on your local machine.
40+
41+
### 4.1 Clone the Repository
42+
First, clone the repository to your local machine using the following command:
43+
```bash
44+
git clone https://github.com/username/medics.git
45+
```
46+
47+
### 4.2 Install Dependencies
48+
Navigate into the project directory and install the required Python packages:
49+
```bash
50+
cd medics
51+
pip install -r requirements.txt
52+
```
53+
Alternatively, you can manually install dependencies:
54+
```bash
55+
pip install pandas openpyxl
56+
```
57+
58+
### 4.3 Database Setup
59+
Ensure that you have the necessary Excel files (patients.xlsx and doctors.xlsx) in the root directory. If not, create them manually or run the following script to generate template files:
60+
```bash
61+
python setup_database.py
62+
```
63+
64+
## 5. Usage Instructions
65+
To start the application, run the following command in your terminal:
66+
```bash
67+
python main.py
68+
```
69+
70+
Follow the prompts to log in or register as a patient or doctor. Patients can submit their diagnoses and schedule appointments, while doctors can view patient information.
71+
72+
## 6. Screenshots
73+
![Login Screen](screenshots/login.png)
74+
![Patient Dashboard](screenshots/patient_dashboard.png)
75+
![Doctor Dashboard](screenshots/doctor_dashboard.png)
76+
77+
## 7. API Reference
78+
### Authentication API
79+
- **Endpoint:** `/api/auth`
80+
- **Methods:** `POST`
81+
- **Request Body:** `{ "username": "user", "password": "pass" }`
82+
83+
### Diagnosis Submission API
84+
- **Endpoint:** `/api/diagnosis`
85+
- **Methods:** `POST`
86+
- **Request Body:** `{ "diagnosis": "diagnosis details", "patient_id": "id" }`
87+
88+
## 8. Troubleshooting
89+
If you encounter issues, try the following steps:
90+
- Ensure all dependencies are installed correctly.
91+
- Check the Excel file paths in the configuration.
92+
- Review the logs for error messages.
93+
94+
## 9. Testing
95+
To run the tests for the Medics software, use the following command:
96+
```bash
97+
pytest
98+
```
99+
100+
Ensure that you have pytest installed:
101+
```bash
102+
pip install pytest
103+
```
104+
105+
## 10. Deployment
106+
To deploy the Medics software, ensure the necessary dependencies are installed and follow the setup instructions for your environment.
107+
108+
## 11. Roadmap
109+
- [ ] Add mobile compatibility
110+
- [ ] Improve user interface
111+
- [ ] Implement cloud storage for data
112+
113+
## 12. License
114+
This project is licensed. See the [LICENSE](LICENSE.md) file for more details.
115+
116+
## 13. Contact
117+
For any inquiries, please contact:
118+
- Email: your_email@example.com
119+
120+
## 14. Contribution Guide
121+
We welcome contributions to the **Medics** project! If you’d like to contribute, please follow these steps:
122+
123+
1. **Fork the Repository**: Click on the "Fork" button on the top right of the repository page.
124+
2. **Clone Your Fork**: Use the following command to clone your forked repository to your local machine:
125+
```bash
126+
git clone https://github.com/your-username/medics.git
127+
```
128+
3. **Create a Branch**: Create a new branch for your feature or bug fix:
129+
```bash
130+
git checkout -b feature-branch-name
131+
```
132+
4. **Make Changes**: Implement your feature or bug fix.
133+
5. **Commit Changes**: Commit your changes with a descriptive message:
134+
```bash
135+
git commit -m "Add feature/bug fix description"
136+
```
137+
6. **Push Changes**: Push your changes to your forked repository:
138+
```bash
139+
git push origin feature-branch-name
140+
```
141+
7. **Create a Pull Request**: Go to the original repository and create a pull request.
142+
143+
## 15. FAQs
144+
**Q1: How do I reset my password?**
145+
A1: Currently, the system does not support password recovery. Please contact your doctor or system administrator to reset your password.
146+
147+
**Q2: Can I run this software on any operating system?**
148+
A2: Yes, the Medics software is compatible with Windows, macOS, and Linux.
149+
150+
**Q3: How is my data stored?**
151+
A3: All patient and doctor data are stored in Excel files. Ensure these files are backed up regularly to prevent data loss.
152+
153+
**Q4: Is there a mobile version of the application?**
154+
A4: Currently, the Medics software is desktop-based. Future updates may include mobile compatibility.

0 commit comments

Comments
 (0)