Find natural remedies from different medical traditions

 

About | Prototype | Setup | Run | Authors

About

Naturdoc is a M.E.R.N app that lets users find the best natural remedies to their common symptoms, in two clicks only,
thanks to a combination of data science research and user-generated reviews.

With the help of Naturdoc, you can learn about the range of applications for each remedy,
rate the remedy and exchange your experience in the comments with other users.
Our inbuilt doctor-alert is symptom based and notifies you when you should seek medical help.

We hope you get better soon!

 

Prototype

 

👀 Watch Demo

 

Setup

Setting Up The Correct .env File:

To ensure that our credentials are not exposed on Github, we have set up a .env file containing necessary data to connect to our MongoDB Atlas database.

There needs to be a .env file in both the backend as well as the pythonapi folder.

The .env file contains data in the following format:

#MONGO CONFIG
MONGO_URI=mongodb+srv://<user>:<password>@<cluster>.aj9zhtw.mongodb.net/<user>?retryWrites=true&w=majority

Therefore, to be able to connect to the database, please contact members of the team to receive the necessary credentials.

 

Python Install:

To receive remedy recommendation from the Data Science API, Python 3 needs to be installed. We used Python3.8 with FastAPI, so we recommend choosing the same version.

• Download Python for Windows and Installation Docs for Windows
• Python for Mac and Installation Docs for Mac

 

Clone Into The Git Repository:

To pull this application to your local machine, execute the following commands from your command line:

git clone https://github.com/TechLabs-Berlin/wt23-naturdoc.git

 

Installing Necessary Dependencies:

To install required dependencies for JavaScript and Python, execute the following commands from your command line:

1. Move to the newly cloned project directory, then navigate to the app folder

cd wt23-naturdoc

cd app

2. Navigate to the frontend folder, then install the dependencies:

cd frontend

npm i

3. Navigate to the backend folder, then install the dependencies:

cd ..

cd backend

npm i

4. Navigate to the Python API folder, and install Python dependencies

cd ..

cd pythonapi

pip install -r requirements.txt

If there are several Python versions installed, users might have to specify the version and run python3.8 -m pip install -r requirements.text instead.

   

Running

1. Navigate to the frontend folder to start the app

cd ..

cd frontend

npm start

2. Navigate to the backend folder to start the local server (serving port 7000)

cd ..

cd backend

npm start

3. Navigate to the Python API folder to start the local server - FastAPI (serving port 8000)

cd ..

cd pythonapi

uvicorn main:app --reload

   

Authors

Data Science:         Aljoscha Beiers  

                                 Anna Stergianou  

WD Frontend:         Rose Jeantet  

WD Backend:          Christina Dechent  

User Experience:    Luzie  

                                  Eugenia Lezcano

   

Mentors

Data Science:            Rafael Saraiva  

Web Development:   Soma Hargitai