diff --git a/README.md b/README.md index 2538552..04d6983 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ Web interface and api for the Open Reaction Database - The test database must be running on port 5432. - You will need to download the Ketcher interface and extract into appropriate folder (see instructions below) for parts of the interface to work. +- To run on Windows, you can use WSL (Windows Subsystem for Linux). If using the Docker option, please ensure that Docker is installed and properly enabled for WSL. ## How to Deploy ...COMING SOON @@ -32,7 +33,8 @@ Web interface and api for the Open Reaction Database ### 1. Download and install ```bash -git clone git@github.com:open-reaction-database/ord-interface.git +# you will need git, python, pip, and postgres installed on your computer first +git clone https://github.com/open-reaction-database/ord-interface cd ord-interface # If you are running on Apple silicon, use `conda install postgresql` instead. conda install -c rdkit rdkit-postgresql @@ -44,6 +46,7 @@ pip install -e '.[tests]' #### Option 1: Docker ```shell +# you will need Docker installed on your computer first cd ord_interface ./build_test_database.sh # If you are running on Apple silicon, append `--build-arg="ARCH=aarch_64"` to the next command. @@ -63,6 +66,7 @@ ORD_INTERFACE_TESTING=TRUE fastapi dev main.py --port=5000 - In a new terminal window: ```shell + # you will need node.js and npm installed on your computer first cd ./app # install node packages npm i