SnoVault JSON-LD Database Framework

System Installation (OSX Catlina10.15.2, Mojave10.14.6)

We will try to keep this updated as OSX, Xcode, and brew update.  However the steps below are
examples and not guaranteed to work for your specific system.  See the dependency's website for
detailed instructions or let us know of any changes with a pull request.

1. Command line tools

   $ xcode-select --install
   

2. brew: https://brew.sh/

3. Python3

   3.6.9 and 3.7.6 have been tested
   3.8 does not work as of Feb 2020
   

4. Postgres@11 (Postgres@9.3 also works)

   $ brew install postgresql@11
   

5. Node 10.x.x

   $ brew install node@10
   

6. Ruby - Non system version to install compass while avoiding permission errors

   $ brew install ruby
   

7. Compass

   $ gem install compass
   # Only do the following commands if the compass location does not exist
   $ ln -s /usr/local/lib/ruby/gems/2.6.0/bin/compass /usr/local/opt/ruby/bin/compass
   

8. Java 8 (Java 11 has also been used)

   $ brew tap AdoptOpenJDK/openjdk
   $ brew cask install adoptopenjdk8
   

9. Elasticsearch 5.x

   $ brew install elasticsearch@5.6
   

10. Brew dependencies

    $ brew install libmagic nginx graphviz
    

11. Chrome driver for Testing

    [Chromedriver](https://chromedriver.chromium.org/downloads) is needed in your PATH.
    If working in a python virtual environment, then the chromedriver can be added to
    your-venv-dir/bin directory.
    

Application Installation

1. Create a virtual env in your work directory.
   Here we use python3 venv module. Use venv, like conda, if you please

   $ cd your-work-dir
   $ python3 -m venv snovault-venv
   $ source snovault-venv/bin/activate
   

2. Clone the repo and install requirements

   $ cd snovault
   $ pip install -r requirements.osx.txt
   

3. Build Application

   # Make sure you are in the snovault-venv
   $ make clean && buildout bootstrap && bin/buildout
   

4. Run Application

   # Make sure you are in the snovault-venv
   $ bin/dev-servers development.ini --app-name app --clear --init --load
   # In a separate terminal, make sure you are in the snovault-venv
   $ bin/pserve development.ini
   

5. Browse to the interface at http://localhost:6543

6. Run Tests

   • no argument runs non bdd tests

   # Make sure you are in the snovault-venv
   $ ./circle-tests.sh bdd
   $ ./circle-tests.sh npm
   $ ./circle-tests.sh