NUBIC/vivo-project

Northwestern University VIVO project

#Northwestern University VIVO project This is a git repository for the Northwestern VIVO instance. It uses the three tiered build approach documented by the VIVO project. The project source files (VIVO and Vitro) are tracked using Git Submodules. This project is a fork of the VIVO project template repository created by Ted Lawless.

For a more detailed explanation of setting up the VIVO environment, consult the VIVO version 1.8 installation instructions.

##Checking out the project and building VIVO in three tiers

###VIVO 1.8

    git clone https://github.com/NUBIC/vivo-project.git vivo
    cd vivo
    git submodule init

#Pull in VIVO and Vitro.  This will take a few minutes.

    git submodule update

#Check out specific versions of VIVO and Vitro

    cd VIVO
    git checkout maint-rel-1.8
    cd ../Vitro
    git checkout maint-rel-1.8

#Change back to vivo main directory

    cd ..

#Copy default build.properties, runtime.properties, and applicationSetup.n3

    cp example.build.properties build.properties
    cp example.runtime.properties runtime.properties
    cp config/example.applicationSetup.n3 config/applicationSetup.n3

#Adjust build, runtime, and applicationSetup properties
#Create the vivo data directory specified in build.properties if it doesn't exist. Eg:

    mkdir -p /usr/local/vivo/data/config
    cp runtime.properties /usr/local/vivo/data
    cp config/applicationSetup.n3 /usr/local/vivo/data/config

#Build and deploy VIVO

    ant all

###VIVO development

$ git clone https://github.com/NUBIC/vivo-project.git vivo_project
$ cd vivo
$ git submodule init
# Pull in VIVO and Vitro.  This will take a few minutes.
$ git submodule update
# Check out specific versions of VIVO and Vitro
$ cd VIVO
$ git checkout develop
$ cd ../Vitro
$ git checkout develop
# Change back to vivo main directory
$ cd ..
# Copy default deploy.properties and edit
$ cp example.build.properties build.properties
$ cp example.runtime.properties runtime.properties
$ cp example.applicationSetup.n3 applicationSetup.n3
# Adjust build and runtime properties
# Create the data directory specified in build.properties if it doesn't exist.
# e.g. $ mkdir -p /usr/local/vivo_project/home
$ cp runtime.properties /usr/local/vivo_project/home
# Build and deploy VIVO
$ ant all
$ cp applicationSetup.n3 /usr/local/vivo_project/home/config/applicationSetup.n3

###Start Tomcat and Verify Build

# Start Tomcat
$ /usr/local/tomcat8/bin/startup.sh
# Tail logfile
$ tail -F /usr/local/tomcat8/logs/catalina.out
# Open browser and goto http://localhost:8080/vivo_project
# Login as root - using default initial password "rootPassword" 
# (cf. installation instructions pdf for VIVO 1.7)

###VIVO 1.7

$ git clone https://github.com/lawlesst/vivo-project-template.git vivo
$ cd vivo
$ git submodule init
#Pull in VIVO and Vitro.  This will take a few minutes.
$ git submodule update
#Check out specific versions of VIVO and Vitro
$cd VIVO
$git checkout maint-rel-1.7
$cd ../Vitro
$git checkout maint-rel-1.7
#Change back to vivo main directory
$cd ..
#Copy default deploy.properties and edit
$cp default.build.properties build.properties
$cp default.runtime.properties runtime.properties
#Adjust build and runtime properties
#Create the data directory specified in build.properties if it doesn't exist.
#E.g. $mkdir -p /usr/local/vivo/data
$cp runtime.properties /usr/local/vivo/data
#Build and deploy VIVO
$ ant all

##Benefits to this approach

• local changes are separated from core code making upgrades easier.
• using Git you can checkout any tagged release, build it with your local changes, and test it out.
• using the steps above, you can quickly deploy VIVO to another machine.
• you can use Git features, like cherry-pick, to select bug fixes or enhancements that are not yet in a VIVO release and incorporate them into your implementation.
• even if you plan on making few modifications, this can be a convenient and efficient way to manage your custom theme.

##Questions or comments Open an issue via the issue tracker.