Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 3.23 KB

README.md

File metadata and controls

42 lines (30 loc) · 3.23 KB
Raw

unbscholar.lib.unb.ca : Lean Instance Repository

Build Status GitHub license GitHub repo size

This repository contains the assets used to test, build, and deploy the unbscholar.lib.unb.ca application.

Documentation

Documentation for this project is available in the documentation folder.

Deploy this Application Yourself!

Local deployment, development and testing of unbscholar.lib.unb.ca is easy, as we leverage dockworker, our unified framework of Robo commands that streamline local development of our application on Linux or OSX.

Step 1: Install Dockworker's Dependencies

In your local development environment, a minimal number of 'one time' dependencies are required to deploy applications with dockworker. Some or all of these may already be installed in your environment; see the list of dependencies and installation instructions here.

Step 2: Deploy

With all dependencies installed, you are ready to deploy any of our applications locally and and begin development:

composer install
vendor/bin/dockworker deploy

And that's it! The application will build and deploy in your local environment.

If you work with unb-libraries applications often, you may also consider installing a dockworker alias, which avoids referencing vendor/bin for each dockworker command.

Other useful commands

Run vendor/bin/dockworker to list available dockworker commands for this application.

Author / Contributors

This application was created at UNB Libraries by the following humans:

License

  • As part of our 'open' ethos, UNB Libraries licenses its applications and workflows to be freely available to all whenever possible.
  • Consequently, the contents of this repository [unb-libraries/unbscholar.lib.unb.ca] are licensed under the MIT License. This license explicitly excludes:
    • Any website content, which remains the exclusive property of its author(s).
    • The UNB logo and any of the associated suite of visual identity assets, which remains the exclusive property of the University of New Brunswick.