From 9b942bad325193a89f94b0b522025adbc8a7c49f Mon Sep 17 00:00:00 2001 From: Ajith Samraj <61262685+AlbusDracoSam@users.noreply.github.com> Date: Mon, 13 Sep 2021 10:31:19 +0530 Subject: [PATCH] Added readme --- README.md | 246 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 200 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 97dd393ca..17d72e643 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,200 @@ -usage: git [--version] [--help] [-C ] [-c =] - [--exec-path[=]] [--html-path] [--man-path] [--info-path] - [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare] - [--git-dir=] [--work-tree=] [--namespace=] - [--super-prefix=] [--config-env==] - [] - -These are common Git commands used in various situations: - -start a working area (see also: git help tutorial) - clone Clone a repository into a new directory - init Create an empty Git repository or reinitialize an existing one - -work on the current change (see also: git help everyday) - add Add file contents to the index - mv Move or rename a file, a directory, or a symlink - restore Restore working tree files - rm Remove files from the working tree and from the index - sparse-checkout Initialize and modify the sparse-checkout - -examine the history and state (see also: git help revisions) - bisect Use binary search to find the commit that introduced a bug - diff Show changes between commits, commit and working tree, etc - grep Print lines matching a pattern - log Show commit logs - show Show various types of objects - status Show the working tree status - -grow, mark and tweak your common history - branch List, create, or delete branches - commit Record changes to the repository - merge Join two or more development histories together - rebase Reapply commits on top of another base tip - reset Reset current HEAD to the specified state - switch Switch branches - tag Create, list, delete or verify a tag object signed with GPG - -collaborate (see also: git help workflows) - fetch Download objects and refs from another repository - pull Fetch from and integrate with another repository or a local branch - push Update remote refs along with associated objects - -'git help -a' and 'git help -g' list available subcommands and some -concept guides. See 'git help ' or 'git help ' -to read about a specific subcommand or concept. -See 'git help git' for an overview of the system. +# [Covisight](https://covisight-hackerearth.herokuapp.com/) + + +### Overview + +* The project titled Covisight deals with the Covid related information.Covisight has a Dashboard which tracks the live COVID data and gives detailed information to the users. + +* It also has a Community module where the users can share their thoughts and ideas. 💭 + +* An ML module that will analyze the chest X-Ray of the patients and predict whether the patient is COVID Positive or Negative. + +* The News module will feed the user with the latest COVID related news across all the countries. 🗞️ + +* The mask detection model predicts whether the person is wearing the mask or not at live time using the live feed. 😷 + +* Payment module enables the user to donate to the needy people. 💸 + +* Hospital module has the details of the hospitals and the availabity of beds all over the India. 🏥 + +*** +### Data Resources + +* Indian Covid data - [Coronacluster](https://coronaclusters.in/) + +* International Covid data - [Johns Hopkins University](https://github.com/CSSEGISandData/COVID-19) + +* Chest X- Ray data set - [Kaggle](https://www.kaggle.com/prashant268/chest-xray-covid19-pneumonia) + +* Vaccination details - [Covid19.org](https://api.covid19india.org/) , [COWIN](https://apisetu.gov.in/public/marketplace/api/cowin) + +* Newsfeed - [NewsAPI](https://newsapi.org/) + +*** + +### Technologies used + +* Django +* Postgres +* Google Data Studio +* Deep Learning +* Teachable Machine +* Rest API +* Payment Gateway + +*** + +### Modules + +#### 1. Home 🏠 + +* Home module contains the common Myth Busters about the COVID-19. + + + +* It also has the popular Podcasts 🎙️ and Youtube videos regarding the COVID-19 prevention, awareness and readiness. + +* There will be a dashboard of Indian COVID-19 distribution. + +*** + +#### 2. Newsfeed 📰 + +* The newsfeed module comprises of the news 📰 regarding the COVID-19. + +* The news are fetched from the NEWSAPI. + +* Top 20 news are displayed in a crisp manner and the user can also navigate to the original data resource. + +*** + +#### 3. Dashboards 📊 + +* It holds the Dashboards of the Indian and International covid distribution, as well the vaccination. + + + + +* The Dashboards are completely live and interactive. + +* The dashboards are created using Google Data Studio and Plotly and the data are taken from the reliable data resources. + +*** + +#### 4. Mask Detection 😷 + +* This module detects if the person wearing the mask or not. + +* It's developed using Teachable Machine. : + +* It get the live data from the webcam and predict. It can also be embedded in CCTV live feed. + +*** + +#### 5. Hospitals info 🏥 + +* It holds the hospital information across the India. + +* It will automatically detect the location and shows the hospitals around the user. + +* Once the user clicked on the hospital it shows the details such as availability of Beds and all. + +*** + +#### 6. Community Forum 🧑‍🤝‍🧑 + +* The users can share their thougts and put their queries here. ❓ + +* Every user can see the posts and can like , dislike and comment on the post. 👍 + + + +* The community forum strictly blocks the abuse talks. The posts are monitored by the admins. + +* If any post violates the terms it will be removed from the posts and the user will be barred from future posts. + +*** + +#### 7. Covid prediction + +* Here the users can upload their Chest X-Ray and the model will predict whether the person has COVID-19 or Pneumonia or a healthy person. + +* The model is built using CNN and the dataset is taken from the kaggle. + + + + +* Once the user uploaded the image it will be uploaded to the [API](https://covidlungsdetection.herokuapp.com/) and the model will predict the output. + +*** + +#### 8. Vaccine information + +* It fetches the data from COWIN API and feeds the data in a compiled manner using the Dashboards. + + + + +* Also it contains the state details and district details. + +* The user can further drill down and filter the data to know the more insights. + +*** + +#### 9. Payment 💰 + +* Here the user can donate to the needy people. + +* Also there will be some categories so that the user can donate to a specific cateogry. + +* We integrated the PayTM payment gateway so it's secure and encrypted. + +* This module is still in testing phase. Once we get the approval from the PayTM the user can actually make the payment. + +*** + +#### 10. FAQs and Screening test + +* Commonly asked FAQs are given here. + +* The screening test asks some questions and it allots the weightage to each answers and give us the exposure to the COVID-19 in percentages. + +*** + +#### 11. Profile + +* The user can create a new account or log in to his account. + +* Also the user can update his profile picture and change the password. + +* User can add the bio. + +* The owner of the post can edit and delete the post. + +*** + +#### 12. Survey + +* We conduct a small survey about the COVID-19, Vaccines and Work life balance. + +* This data is confidential and only for educational purpose. + +* The survey is created using the Typeform. + +#### + +Visit our site here ➡️ [Covisight](https://covisight-hackerearth.herokuapp.com/) + +Feel free to contribute to our project. Have a nice day 😃 + + + + + + + + + + + +