Skip to end of metadata
Go to start of metadata
- All the backed modules contain a Vagrantfile
- this is for convenience, but it's really important to note that you only ever run 1 vagrant image - and that will coordinate all the modules you want to run
- so if you want to run mod-agreements and mod-licenses together, you will need to use only one of the Vagrantfile images - usually use the mod-agreements one
- Once you have done a
vagrant up you have a folio running with a base collection of modules.
- We then need to start up our backend modules - mod-agreements and mod-licenses -
- Both modules have a scripts directory with a run_external_reg.sh script which you probably want to use.
- The process is usually
cd <module>/service; grails war; ../scripts/run_external_reg.sh
- NOTE: the run_external_reg.sh script uses a jar file in ../build/libs. The script may need to be modified to use the correct version of the jar file.
- This is enough to build the module and start it up.
- At this point you have a running folio and your running modules, but the running OKAPI does not know that it should route requests for the diku tenant to your running modules.
- In order to do that we provide a
register_and_enable.sh script in the scripts directory
- NOTE: This script uses the "jq" command, which may be installed on a MAC using "brew".
- Running this script (one for each backend module you want to enable for the diku tenant) will connect the okapi running in the vagrant image to the running modules.
- This gets you a backend system.
- Both modules have test scripts that you can use to exercise the backend as a whole by talking to the OKAPI on port 9130.
- You will see a script called okapi-cmd in both scripts directory - you can use this to trigger a URL directly - for example
./okapi-cmd.sh /licenses/licenses will trigger the index action on the licenses controller in the licenses module.
- The front-end can easily be deployed by using the platform-erm Stripes platform.
- To use local copies of applications with checked-out repositories, following the instructions in the Developing and Contributing section