Bluesheet

Track membership and roles within various groups, committees, taskforces, and departments at UMN.

• aka: groups.cla.umn.edu
• aka: caligari

Set Up

Blue Sheeet uses Laravel's docker environment, Laravel Sail for development.

Prereqs:

• Docker
• PHP v7.4
• Composer
• Node LTS

To get started:

# Create a .env file
cp .env.example .env

# create auth.json for Nova credentials
cp auth.json.example auth.json

# add your username/key to auth.json

# Install php dependencies
composer install

# Start Sail
sail up

# create app key, link storage, etc
sail exec app ./bin/ci.sh

# migrate the database
sail artisan migrate:fresh --seed

# Install node modules
npm install

# Start Vite
npm run dev

The application will be running on http://localhost.

Using the Application

sail up
npm run dev

Load http://localhost in your browser.

Login with:

• username: admin
• password: admin

Additional users can be configured in config/shibboleth.php.

Stop the application: sail down.

Local Development with Bandaid

Some features of BlueSheet require access to Bandaid API (e.g. the Faculty Leaves Planning Report page).

To connect to Bandaid for local development:

1. Connect to UMN VPN.
2. Login to https://bandaid.cla.umn.edu/admin
3. In Bandaid, add a new API Token for your user: Users > username > Edit > Add Token.
4. Add the token in .env as BANDAID_KEY=<your token>
5. Get your VPN ip address from https://z.umn.edu/ip
6. Add your ip address to Bandaid's Allow List. (You'll need to do this each time your ip address changes. Be sure to remove the old ip address from the list.)

Deploy

Enviroment Name	URL
dev	https://cla-bluesheet-dev.oit.umn.edu
stage	https://cla-bluesheet-tst.oit.umn.edu
prod	https://bluesheet.cla.umn.edu

./vendor/bin/dep deploy <environment name>

Documentation

BlueSheet documentation is in the docs folder, and published at https://umn-latis.github.io/bluesheet/. It uses VitePress for static site generation.

To develop locally:

cd docs
npm install
npm run docs:dev

Building the documentation:

cd docs
npm run docs:build

and publishing:

cd docs
npm run docs:publish