ChimeIn

Real time polling for your presentations

Chime-In is a web-based "clicker" tool for doing live polling in interactive presentations.

Setting up ChimeIn Locally

Chime in uses Laravel's docker environment, Laravel Sail for development. To get sarted:

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

# Edit `.env` as needed.
# The default `.env.example` will probably be sufficient,
# but if you're a Safari user, change SESSION_SAME_SITE="none"

# Install php deps
docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/var/www/html \
    -w /var/www/html \
    laravelsail/php81-composer:latest \
    composer install --ignore-platform-reqs

# Build docker image
sail build --no-cache

# Start Sail
sail up

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

# migrate the database
sail artisan migrate:fresh

# seed the database with some sample data
sail artisan db:seed

# Install node modules
yarn install

# Start Vite to compile Vue
yarn dev

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

Using the Application

sail up
yarn 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.

Running Tests Locally

yarn run cypress

Deploy

Enviroment Name	URL
dev	https://cla-chimein-dev.cla.umn.edu
stage	https://cla-chimein-stage.cla.umn.edu
prod	https://chimein.umn.edu

./vendor/bin/dep deploy <environment name> --branch <branch to deploy>

For example:

./vendor/bin/dep deploy dev --branch feature/my-feature

Documentation

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

To develop locally:

cd docs
yarn install
yarn docs:dev

Building the documentation:

cd docs
yarn docs:build

and publishing:

cd docs
yarn docs:publish