Commit 291d8bec authored by Yuncong Yu's avatar Yuncong Yu
Browse files

Update readme.

parent ee31662e
......@@ -14,6 +14,8 @@ To run the application, make sure you've installed the following:
1. Python >=3.5: https://www.python.org/downloads/
2. Conda: https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html
3. Angular: https://angular.io/guide/setup-local
4. Java: https://www.java.com/en/download/help/download_options.html
5. `make` in git Bash in Windows: https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058
### Step 1: Creating an environment
All dependencies are listed in the *environment.yml* file. To create an environment, run the following command:
......@@ -23,14 +25,15 @@ This will create a conda environment named *pseudo*. Now activate the environmen
### Step 2: Prepare backend - creating the LSH package
The LSH algorithm is maintained locally for now, so you'll have to create it manually. The file that you need to setup this package is located in the Flaskserver folder (this is more efficient when debugging, as for every change you have to rebuild the package). So the package can be created by running the following code:
`cd Flaskserver`
`cd Flaskserver\libs`
`python3 setup.py build_ext --inplace && python3 setup.py install`
`cd ..`
**NOTE 1**: So as a reminder, don't forget to run the 2nd line everytime you change something in the c++ code.
### Step 3: Prepare frontend - install Node packages
The cloned Angular repository cannot be used directly. You have to install the node packages via
`cd Angular`
`cd AngularApp/prototypes`
`npm install`
### Step 4: Running PSEUDo
As mentioned before, PSEUDo exists of a gui and a server. A Makefile is provided to setup both easily. Just run the following code for the server and gui respectively:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment