Skip to content

Commit 4c30343

Browse files
authored
Merge branch 'main' into mined-data-label
2 parents 387f7d9 + eefb054 commit 4c30343

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Web interface and api for the Open Reaction Database
2323
- The test database must be running on port 5432.
2424
- You will need to download the Ketcher interface and extract into appropriate folder (see instructions below) for
2525
parts of the interface to work.
26+
- 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.
2627

2728
## How to Deploy
2829
...COMING SOON
@@ -32,7 +33,8 @@ Web interface and api for the Open Reaction Database
3233
### 1. Download and install
3334

3435
```bash
35-
git clone [email protected]:open-reaction-database/ord-interface.git
36+
# you will need git, python, pip, and postgres installed on your computer first
37+
git clone https://github.com/open-reaction-database/ord-interface
3638
cd ord-interface
3739
# If you are running on Apple silicon, use `conda install postgresql` instead.
3840
conda install -c rdkit rdkit-postgresql
@@ -44,6 +46,7 @@ pip install -e '.[tests]'
4446
#### Option 1: Docker
4547

4648
```shell
49+
# you will need Docker installed on your computer first
4750
cd ord_interface
4851
./build_test_database.sh
4952
# 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
6366
- In a new terminal window:
6467

6568
```shell
69+
# you will need node.js and npm installed on your computer first
6670
cd ./app
6771
# install node packages
6872
npm i

0 commit comments

Comments
 (0)