Skip to content

jacob-gardiner/retro-board

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Retro Board

Team retrospective board built with Laravel 11, Jetstream, Inertia + Vue 3, Tailwind, MySQL, Redis, and Laravel Reverb for real-time updates. Everything can run in Docker; the only host tool you need beyond Docker is Node via nvm.

Prerequisites

  • Docker + Docker Compose
  • nvm (uses the Node version pinned in .nvmrc, currently 20.11.0)

Initial setup

  1. Clone the repo and enter it.
  2. Copy env vars and set local defaults for Sail:
cp .env.example .env
  1. Install PHP dependencies using Sail’s Composer image (no local PHP required):
docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/var/www/html" -w /var/www/html laravelsail/php83-composer:latest composer install --ignore-platform-reqs
  1. Start the stack: ./vendor/bin/sail up -d
  2. Generate keys/links: ./vendor/bin/sail artisan key:generate && ./vendor/bin/sail artisan storage:link
  3. Prepare the database: ./vendor/bin/sail artisan migrate --seed
  4. Run background workers needed for real-time updates:
    • Queue worker or Horizon: ./vendor/bin/sail artisan horizon (or queue:work)
    • Reverb websocket server: ./vendor/bin/sail artisan reverb:start
  5. Set up Node and the Vite dev server on the host:
nvm install
npm install
npm run dev
  • Vite runs on port 5173 by default (published in docker-compose.yml); visit http://localhost.

Useful commands

  • Stop the stack: ./vendor/bin/sail down
  • Backend tests: ./vendor/bin/sail artisan test
  • Frontend tests: npm test

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published