Skip to content

joshhanna/vivo-project-template

 
 

Repository files navigation

#VIVO project template This is a git repository template for working with and customizing VIVO. It uses the three tiered build approach documented by the VIVO project. The project source files (VIVO and Vitro) are tracked using Git Submodules.

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

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

###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

###VIVO development

$ 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 develop
$cd ../Vitro
$git checkout develop
#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

###VIVO 1.5 or earlier

$ git clone https://github.com/lawlesst/vivo-project-template.git vivo
$ cd vivo
$ git checkout 1.5
$ 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.5
$cd ../Vitro
$git checkout maint-rel-1.5
#Change back to vivo main directory
$cd ..
#Copy default deploy.properties and edit
$cp default.deploy.properties deploy.properties
#Adjust deploy.properties
#Create the data directory specified in deploy.properties if it doesn't exist.
#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.

About

A template for getting started with a VIVO implementation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 93.3%
  • CSS 6.7%