Skip to content

Commit

Permalink
modify repo structure
Browse files Browse the repository at this point in the history
  • Loading branch information
mishal23 committed May 23, 2021
1 parent 2c26529 commit d6bbf0b
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 47 deletions.
File renamed without changes.
1 change: 1 addition & 0 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Contributing

- The repository is open for all kind of contributions (feature adding, bug fixing)
- You can also write by opening an Issue and also solve a current issue if possible.
- Fork this project to your Github account.
Expand Down
67 changes: 20 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,28 @@
[![Coverage Status](https://img.shields.io/codecov/c/github/mishal23/virtual-clinic.svg)](https://codecov.io/gh/mishal23/virtual-clinic)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1873/badge)](https://bestpractices.coreinfrastructure.org/projects/1873)
![my website](https://img.shields.io/website-up-down-green-red/http/virtual-clinic.herokuapp.com.svg?label=website)
<a href="https://scan.coverity.com/projects/mishal23-virtual-clinic">
<img alt="Coverity Scan Build Status"
src="https://scan.coverity.com/projects/15847/badge.svg"/>
</a>
[![HitCount](http://hits.dwyl.com/mishal23/virtual-clinic.svg)](http://hits.dwyl.com/mishal23/virtual-clinic)
[![Commits](https://github-basic-badges.herokuapp.com/commits/mishal23/virtual-clinic.svg)]()
[![License](https://github-basic-badges.herokuapp.com/license/mishal23/virtual-clinic.svg)]()
[![Pulls](https://github-basic-badges.herokuapp.com/pulls/mishal23/virtual-clinic.svg)]()
[![Issues](https://github-basic-badges.herokuapp.com/issues/mishal23/virtual-clinic.svg)]()


A software to simplify the process of Health Care in hospitals to help the patients, doctor, labs, chemist.

## Introduction
- Everything is well documented, please take a look at [docs](/docs) folder.

- Everything is well documented, please take a look at [docs](./docs) folder.
- All the required UML Diagrams are also drawn.
- Finally it is also deployed: http://virtual-clinic.herokuapp.com/
- Steps to deploy are mentioned [here](/DEPLOY.md)
- Steps to setup the project are mentioned [here](./docs/INSTALLATION.md)
- Steps to deploy are mentioned [here](./docs/DEPLOY.md)

## Features:

- Common Login for all users
- Patient Registration

### Admin

- Add Doctor/Lab/Chemist
- Archive Users
- Restore Archived Users
Expand All @@ -40,6 +38,7 @@ A software to simplify the process of Health Care in hospitals to help the patie
- Change Password

### Patient

- Create Appointments
- Update Medical Information
- View Prescriptions
Expand All @@ -50,75 +49,49 @@ A software to simplify the process of Health Care in hospitals to help the patie
- Change Password

### Doctor

- Consult Appointments
- View/Update/Generate Prescriptions
- View Medical Information of patients
- Update Profile
- Change Password

### Lab

- Upload Medical Tests
- View/Send Messages
- Update Profile
- Change Password

### Chemist

- Update Medicine Delivery Status(Update Prescriptions)
- View/Send Messages
- Update Profile
- Change Password

## Structure of Repository

- The repository has mainly three branches:
<table>
<thead>
<tr>
<td><b>Branch</b></td>
<td><b>Build Status</b></td>
<td><b>Database</b></td>
</tr>
</thead>

<tbody>
<tr>
<td>master</td>
<td>Passing</td>
<td>SQLite</td>
</tr>
<tr>
<td>development</td>
<td>Passing</td>
<td>MySQL</td>
</tr>
<tr>
<td>production</td>
<td>Passing</td>
<td>PostgreSQL</td>
</tr>
</tbody>
</table>

- All the documents are in `docs` folder.
- All the UML Diagrams are in `UML Diagrams` folder.
- In the virtualclinic folder
- `public` folder contains all the templates.
- `server` folder contains the views.
- `testing` folder contains all the tests cases.
- `virtualclinic` folder contains Django configuration files for the project.
- `public` folder contains all the templates.
- `server` folder contains the views (business logic).
- `testing` folder contains all the tests cases.
- `virtualclinic` folder contains Django configuration files for the project.

## Contributing

- The repository is open for contributions from all interested developers.
- Also, you can write by opening an Issue and also solve a current issue if possible.
- Fork this project to your Github acoount.
- After forking, clone the repository to local system and make the necessary changes.
- Kindly send Pull Requests with explanation as to what changes you have done.

## Feature Requests

- Incase you would like to see a feature to be implemented in this project, please open an issue, or send an email to me!

## License
- The software is under MIT License

## Contributors
- Samyak Jain ([@SamyakJ2512](https://github.com/SamyakJ2512))
- Ashwin Joisa ([@Aj163](https://github.com/Aj163))
- Mehnaz Yunus ([@mehnazyunus](https://github.com/mehnazyunus))
- Mishal Shah ([@mishal23](https://github.com/mishal23))
- The software is under MIT License
1 change: 1 addition & 0 deletions db/create_tables.sql
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
-- DO NOT USE THIS, PLEASE USE DJANGO MIGRATIONS, THIS IS JUST FOR ILLUSTRATORY PURPOSE
CREATE DATABASE IF NOT EXISTS `vclinic`;
use `vclinic`;

Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit d6bbf0b

Please sign in to comment.