UBL Laravel Template

A Laravel template that includes most of the stuff required to get a Laravel project going at the UB!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact
4. Acknowledgments

About the project

The UBL Laravel Template repository is developed to include most of the usual requirements to create a new UBL web application. It includes SAML2 scaffolding, custom error pages, the Leiden University color scheme, and more.

(back to top)

Features

• SAML2 integration, optimized for ULCN and for local development
• Custom error pages with the Leiden University logo
• Admin home page
• Log viewer for admins
• Microsoft Teams notifications
• Bootstrap 5
• Leiden University logos and color scheme
• MkDocs material template for technical documentation
• Pre-generated Issues, Feature Requests, TODO, and Pull Requests templates for GitHub

(back to top)

Built with

• 
• 

(back to top)

Getting started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• PHP ^8.1 - The version available on the Leiden University Libraries servers

• MySQL + a database

• Composer

• Python 3.* - Required for MkDocs

• npm - for publishing the css, js, etc. To install on a semi-managed machine:

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/LeidenUniversityLibrary/UBL-repository-template.git

2. Install composer packages. In the cloned repository's folder:

   composer install

3. Copy the .env.example file to a .env. In the cloned repository's folder:

   cp .env.example .env

4. Generate and application key

   php artisan key:generate

5. Modify the .env file with your local details. Pay attention to the DB_DATABASE= field: it must match the one you generated on your machine. Insert your ulcn username in SAML2_ULCN_USERNAME= field.

6. php artisan migrate:fresh --seed to create tables and create a dummy admin for local environments. The admin name will be SAML2_ULCN_USERNAME=

7. npm install && npm run dev to generate the required resources (css, js, etc.)

8. php artisan serve to launch your application locally

(back to top)

Contact

Leiden University Libraries - Digitale Diensten Project link: https://github.com/LeidenUniversityLibrary/UBL-repository-template

(back to top)

Acknowledgments

• Material for MkDocs
• Best-README-Template

(back to top)

License

Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.

(back to top)