Help the team



Step 1: Setting up the PeARS environment

First, the best way to get acquainted with the current state of the project is to install the development version. Please follow the instructions here to set things up

Click to expand Instruction set

  1. 1. Clone PeARS repo

    git clone https://github.com/PeARSearch/PeARS-orchard.git
    cd PeARS-orchard
  2. 2. Setting up the environment

    1. 2.1. Set up virtualenv

      We recommend using virtualenv for the development. If you are just here for test it out, skip to the next section.

      Install pip3 using easy_install
      sudo easy_install pip3

      or some other way your distribution supports like:

      sudo yum install python3-pip
      Install virtualenv using pip3
      sudo pip3 install virtualenv
      Create a new virtualenv for PeARS and activate it
      virtualenv -p python3 env && source env/bin/activate
    2. 2.2. Install the build dependencies

      We recommend using pip for installation. In case you don't have this, look inside requirements.txt and install dependencies manually.

      pip3 install -r requirements.txt
    3. 2.3. Unpack the semantic space

      In the root directory of the repo, run

      cd app/static/spaces

      then

      english.dm.zip
  3. 3. Running the PeARS search engine

    In the root directory of the repo, run

    python3 run.py

    Go to the browser and type localhost:8080. You should find PeARS running there. You don't have any pages indexed yet, so go to the F.A.Q. page (link at the top of the page) and follow the short instructions to get you going!

Do let us know is anything isn't working for you by opening an issue on the GitHub page!

Step 2: Check for open issues

Check out the current issues in the PeARS repo. You may find something you might like to contribute to. Things are changing quite rapidly, so it is always best to drop us a short line saying you'd like to take on the issue before you actually make a start. We may have more up-to-date info than what is on GitHub!

Step 3: Connect with the Team

if you have other ideas, comments, problems, don't hesitate to contact us, either on the GitHub issue page, or via IRC. One of us is usually hanging about at #pears on Freenode.