Skip to content
This repository has been archived by the owner on Oct 13, 2022. It is now read-only.

Commit

Permalink
Merge pull request #1 from jhaasdijk/master
Browse files Browse the repository at this point in the history
Updated README.md. Thanks for this update, @jhaasdijk! Looks better.
  • Loading branch information
minimalparts authored Oct 12, 2018
2 parents 526a376 + fd0c0a0 commit 6fcc94e
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,34 @@ In order to use this repo, you need to have copy of [PeARS, version Orchard](htt

## Learn to use your pod locally

1. Clone this repo on your machine:
#### 1. Clone this repo on your machine:

git clone https://github.com/PeARSearch/PeARS-pod.git


2. Setup a virtualenv in your directory (**this step is optional**):
#### 2. Optional step Setup a virtualenv in your directory.

virtualenv -p python3 env && source env/bin/activate

3. Install the build dependencies:
#### 3. Install the build dependencies:

pip3 install -r requirements.txt

4. Head over to the app/static/spaces directory and unzip english.dm.zip.
#### 4. Unpack the semantic space

Head over to the app/static/spaces directory and unzip english.dm.zip.

#### 5. Tell your pod what to index.

5. Tell your pod what to index. You should save a csv file containing your pod in the *app/static/pods* folder. If you don't know yet what a csv pod is, consult <a href="https://pearsearch.org/faq.html#newpods">the documentation on PeARS Orchard</a>.
You should save a csv file containing your pod in the *app/static/pods* folder. If you don't know yet what a csv pod is, consult <a href="https://pearsearch.org/faq.html#newpods">the documentation on PeARS Orchard</a>.

6. In the root of the repo, run:
#### 6. Run it!

In the root of the repo, run:

python3 run.py

Now, go to your browser at localhost:5000. You should see your pod running. Happy searching!


## Putting your pod online

You can setup your pod online on any server that will let you run a Flask application with a database. We provide specific instructions for use with <a href="https://www.pythonanywhere.com/">https://www.pythonanywhere.com/</a>. These can be found [on the Wiki](https://github.com/PeARSearch/PeARS-pod/wiki/Deploying-a-PeARS-pod-on-PythonAnywhere).

0 comments on commit 6fcc94e

Please sign in to comment.