Skip to content

Commit

Permalink
modified readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Raghav010 committed Nov 9, 2023
1 parent b7b2d0a commit 30bf561
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 11 deletions.
6 changes: 5 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
medmini.pdf
README.md
media/
run.sh
install.sh
docker-run.sh
.gitignore
.git/
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,22 @@
![Pipeline](./media/diagram.png)


## **Installation Instructions**

### **Quickstart - Docker** _Memory Heavy_
- `sudo chmod +x docker-run.sh`
- `sudo ./docker-run.sh`

## **Instructions for Setup**
**Uninstalling**
- `sudo docker image rm medmini`


### **Raw Install** _Best Performance_
- `sudo chmod +x install.sh ; ./install.sh`
- `sudo chmod +x run.sh ; ./run.sh`
- _Need to have a ubuntu>=22.04 or debian>=12 based distro_

1. `cd mashqa_data`
2. `python format.py`
3. `cd ..; python dbGen.py`

## **Instructions to run**
1. `cd App; npx expo start`
2. `python backend.py`

## **Future work**
1. Dockerisation of the project to allow it to run from any IP address without having to do many changes.
2. Improve the RAG algorithm without compromising on efficiency
1. Improve the RAG algorithm without compromising on efficiency
6 changes: 6 additions & 0 deletions docker-run.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash


docker pull medmini

docker run -it --rm -p 8081:8081 -p 5000:5000 -e REACT_NATIVE_PACKAGER_HOSTNAME=$(hostname -I | awk '{print $1}') -e EXPO_DEVTOOLS_LISTEN_ADDRESS="0.0.0.0" medmini
14 changes: 13 additions & 1 deletion run.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
#!/bin/bash

# subshell for starting frontedn and backend
# setting environment variables
export REACT_NATIVE_PACKAGER_HOSTNAME=$(hostname -I | awk '{print $1}')
export EXPO_DEVTOOLS_LISTEN_ADDRESS="0.0.0.0"

# starting frontend and backend
python3 backend.py &
cd App/ ; echo EXPO_PUBLIC_HOSTIP=$REACT_NATIVE_PACKAGER_HOSTNAME > .env
npx expo start &

wait -n

exit $?

1 change: 1 addition & 0 deletions todo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- provide the med_db data on a link

0 comments on commit 30bf561

Please sign in to comment.