Skip to content

Commit 9e48f4a

Browse files
authored
Update README.md
1 parent 1e124c8 commit 9e48f4a

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# :mask: **Covid19 Detector**
22
![Awesome](https://img.shields.io/badge/.-Awesome-%23FC60A8?style=for-the-badge&logo=awesomelists)
33
![Builed](https://img.shields.io/azure-devops/build/totodem/8cf3ec0e-d0c2-4fcd-8206-ad204f254a96/2?style=for-the-badge)
4+
![Static Badge](https://img.shields.io/badge/PYTHON-3.10_%7C_3.11-blue?style=for-the-badge)
5+
![Static Badge](https://img.shields.io/badge/Python-3.12_%7C_FAILED-red?style=for-the-badge)
46
![License](https://img.shields.io/packagist/l/doctrine/orm?style=for-the-badge)
57

68
| . | . |
79
| - | - |
810
| ![Covid19DetectorLandingPage](https://user-images.githubusercontent.com/60509979/194156486-b84abf8b-5c78-427d-94bf-1bb696f2f386.png) | ![Covid19DetectorResultShow](https://user-images.githubusercontent.com/60509979/194156563-14d3a535-28ed-450c-9e71-f01e70cf020b.png) |
911

1012

11-
In this project, I have a Django-React Web App which can detect COVID-19 from CT Scan Images.
13+
In this project, I have a Python Django Web App which can detect COVID-19 from CT Scan Images.
1214

1315
## :movie_camera: **<a href="https://bitterocean.github.io/Covid19-Detector/">Live Demo</a>**
1416

@@ -43,7 +45,8 @@ In this project, I have a Django-React Web App which can detect COVID-19 from CT
4345

4446
this is the architecture of **DenseNet121**
4547

46-
![densenet121](https://user-images.githubusercontent.com/60509979/197634917-e845bca3-510d-4acc-803f-ed0698a693bc.png)
48+
49+
![densenet121](https://user-images.githubusercontent.com/60509979/197634786-ef252436-1e5f-472c-b775-3c245e6dbb70.png)
4750

4851

4952
### :monocle_face: **Model Evaluation**
@@ -77,7 +80,6 @@ this is the architecture of **DenseNet121**
7780

7881
## :woman_technologist: **Web App Backend**
7982

80-
8183
[![Pinned Repository](https://github-readme-stats.vercel.app/api/pin/?username=BitterOcean&repo=Covid19-Detector-Backend)](https://github.com/BitterOcean/Covid19-Detector-Backend)
8284

8385

@@ -89,13 +91,26 @@ git clone https://github.com/BitterOcean/Covid19-Detector-Backend.git
8991

9092
then, create a virtual enviroment and install python required packages :
9193

94+
- Linux Users
95+
9296
```bash
9397
cd Covid19-Detector-Backend
9498
python3 -m venv .env
9599
source .env/bin/activate
96100
pip install -r requirements.txt
97101
```
98102

103+
- Windows Users
104+
105+
open a windows terminal and follow the instructions below:
106+
107+
```bash
108+
cd Covid19-Detector-Backend
109+
python3 -m venv .env
110+
.env\Scripts\Activate.ps1
111+
pip install -r requirements_win.txt
112+
```
113+
99114
finally, go to the project directory and run the bachend django server :
100115

101116
```bash
@@ -143,20 +158,25 @@ then, go to the project directory and install required node modules :
143158
```bash
144159
npm i
145160
```
161+
if you got any errors try using ```--force``` flag.
162+
```bash
163+
npm i --force
164+
```
165+
146166
after that, to use it locally, you have to change only one line in ```src/constants/routes.jsx```, so :
147167
```bash
148168
cd Covid19-Detector/src/constants
149169
```
150170
and then change the first line, like below :
151171
```diff
152172
- export const API_ROOT = 'https://covid-19-detector-model.herokuapp.com';
153-
+ export const API_ROOT = 'http://127.0.0.1:8000/';
173+
+ export const API_ROOT = 'http://127.0.0.1:8000';
154174
```
155175
and finally :
156176
```bash
157177
npm start
158178
```
159-
Now the frontend will run on <a href="http://127.0.0.1:3000/">http://127.0.0.1:3000/</a>.
179+
Now the frontend will run on <a href="http://127.0.0.1:3000/Covid19-Detector">http://127.0.0.1:3000/Covid19-Detector</a>.
160180
<br />
161181
Eventually, here is the point that everything is ready and you can start using the the "Covid19-Detector". :slightly_smiling_face:.
162182

0 commit comments

Comments
 (0)