update setup in readme and add to .gitignore

.gitignore

@@ -1,17 +1,27 @@
-/test.py
-db.sqlite3
+# Development Environment
 .vscode
-data/*
-__pycache__
 .DS_Store
-Lib/*
-Scripts/*
-*.cfg 
-credentials/
-back.sqlite3
+
+# Python
 *.ipynb
+__pycache__
+venv/
+.python-version
+
+# Misc and Config
 .sass-cache/
 .sass-cache/*
 logs/*
 /static/
-visual/config.yml
+*.cfg 
+
+/test.py
+Lib/*
+Scripts/*
+
+credentials/
+back.sqlite3
+db.sqlite3
+data/*
+visual/config.yml
+

README.md

@@ -2,37 +2,40 @@
 
 ![Screenshot of platform](screenshot.jpeg)
 
-[Clinicaltrials.gov](https://clinicaltrials.gov) is a website that people all around the world submit the progress and the information of the medical trials on it. Tir-AL is a visualization platform to keep track of clinicaltrials.gov data along with more valuable tools. Tri-AL allows clinicaltrials researchers explore the database in a novel way. It can be used as both standalone project and a baseline for further improvement. It is still under development and we are trying to make it as perfect as possible. 
+[Clinicaltrials.gov](https://clinicaltrials.gov) is a website that people all around the world submit the progress and the information of the medical trials on it. Tri-AL is a visualization platform to keep track of clinicaltrials.gov data along with more valuable tools. Tri-AL allows clinicaltrials researchers explore the database in a novel way. It can be used as both standalone project and a baseline for further improvement. It is still under development and we are trying to make it as perfect as possible. 
 
 Setup
 ------
-1. Activate environment and install all requirements using pip command and requirements.txt file.
+1. Ensure you are using Python 3.10
+
+2. Install non python requirements: `postgresql``, `shapely`, and `geos`. On Mac with homebrew use `brew install postgresql shapelib geos`
+
+3. Activate environment and install all requirements using pip command and requirements.txt file.
 ```console
 pip install -r requirements.txt
 ```
+4. Update config file by using sample config file. The config file is located in `visual/sample-config.yml`. Name config to `config.yml` in the same directoy. It can be done as following as well:
+```console
+cp visual/sample-config.yml visual/config.yml
+# EDIT config.yml WITH ANY EDITOR
+```
 
-2. Intialize database and setting up project.
+5. Intialize database and setting up project.
 ```console
 chmod +x initdb.sh
 ./initdb.sh
 ```
 
-3. Download the concent of clinicaltrials.gov from [here](https://clinicaltrials.gov/AllPublicXML.zip) as a zip file to initialize database.
+6. Download the concent of clinicaltrials.gov from [here](https://clinicaltrials.gov/AllPublicXML.zip) as a zip file to initialize database.
 
-4. Unzip the `AllPublicXML.zip` and place the content under `data` directory in the project root. For example `data/AllPublicXML/`.
+7. Unzip the `AllPublicXML.zip` and place the content under `data` directory in the project root. For example `data/AllPublicXML/`.
 
-5. Import all the XML files to the database.
+8. Import all the XML files to the database.
 ```console
 python3 data_manager.py import -i data/AllPublicXML
 ```
 
-6. Update config file by using sample cofing file. The config file is located in `visual/sample-config.yml`. Name config to `config.yml` in the same directoy. It can be done as following as well:
-```console
-cp visual/sample-config.yml visual/config.yml
-# EDIT config.yml WITH ANY EDITOR
-```
-
-7. Start project using Django and access it through [browser](http://localhost:8000/admin)!
+9. Start project using Django and access it through [browser](http://localhost:8000/admin)!
 ```console
 python3 manage.py runserver
 ```
@@ -51,3 +54,7 @@ Project Structure
     ├── data_manager.py         # Main script to maintain database and download and fill database
     ├── manage.py               # Django script to perform different actions for app
     └── .gitignore
+
+Troubleshooting
+------
+- This project uses Django 3.3.18 so you need a compatible Python version (e.g. `3.10`)