This is a guide for setting up and running vireo4 for development purposes. These instructions were tested on Mac OS X but would be similar for unix variants.
####SETUP
## Get the Vireo 4 code
Download the latest Vireo repository
git clone https://github.com/TexasDigitalLibrary/Vireo.git
git branch -a #list all branches
Use the 4.0.x branch
git checkout 4.0.x
git checkout 4.0.x-pr_1054-corrections
## Create your own branch from 4.0.x
The branch name should contain a sprint name (if applicable), the issue number, and a few word description about the issue.
git checkout -b 'sprint88_issue999_FixDisplaySettings'
## Run locally in development mode.
The README.md file contains information on running in development mode. For some development you may want generated test data. For this you will need to start Vireo in development mode with a console.
mvn clean spring-boot:run -Drun.arguments=console
You will see a lot of console output including 'node-pre-gyp' errors and other dire sounding text. Ignore.
## SIGN IN AND USE
Point your browser to http://127.0.0.1:9000 or http://localhost:9000
Since you are running locally and presumably do not want to configure a mail server, you can sign in with a built in account for testing. Click on the Login button or link and then a pop-up sign in box will appear. Click on the 'Shibboleth Login' button. You will now be signed in as 'Jack Daniels' and have ADMIN privileges.
Click on the Jack Daniels button. This will display a dropdown menu. Choose 'List' from the menu. This will take you to a page with 3 tabs: List, View, and Settings. Since you have no data the List will be empty.
To generate data, return to the console and hit return. You will see a prompt;
vireo>
Enter 'generate 2' and hit return. This will generate 2 sample entries.
Refresh your browser page to see the 2 ETDs listed.
Click on one of them. This will bring you to the View tab, open to the subtab of Personal Information. You will have the option to edit various fields by clicking on the pencil icon to the right of an entry. Other fields appear on the Personal Information and Document Information subtabs.
NOTE: Some generated data does not fit the format - you may encounter errors if you perform an action that relies on a particular data field.
e.g. you may wish to filter a list based on graduation date but the auto generated data is a non date string. You will need to update the element of your list with real dates.
###CODE ORGANIZATION
Vireo4 uses spring boot and angular js (https://angularjs.org, not https://angular.io)
Vireo4 relies on two other repos:
https://github.com/TAMULib/Weaver-Webservice-Core
and
https://github.com/TAMULib/Weaver-UI-Core
which are pulled in via maven.
The former is used by the server side and the latter is used by the angularjs thymeleaf front end. It is unlikely that a bug fix will draw you to this code but you will see references to these repos in the code.
Settings are in src/main/resources/application.properties (a recent change may mean these are in src/main/resources/application.yaml). This file contains settings such as server port number, h2 config, and others. Most of these settings will only be relevant during a production deployment.
The h2 console can be reached at http://127.0.0.1:9000/admin/h2console user id is 'sa' and no password is required
###SPRINT
Sprint participants will use https://waffle.io/TexasDigitalLibrary/Vireo to track issues.
A slack channel and bluejeans id may also be set up for the community sprint.