joelgaillard/comem-wopr

Play tic-tac-toe against the WOPR

WOPR

Play tic-tac-toe against the WOPR.

• Installation
  • Requirements
  • Initial setup
• Usage
  • Run in development mode
  • Run in production mode
• Updating
• Configuration

Installation

Requirements

• Ruby 2.7.x or 3.x
• Node.js 20.x
• Redis 4+

Initial setup

# Clone the repository
git clone https://github.com/MediaComem/comem-wopr.git
cd comem-wopr

# Configure Bundler.
bundle config set path 'vendor/bundle'

# Install dependencies (Ruby gems & npm packages).
bundle install
npm ci

# Build the web assets.
npm run build

Usage

Run in development mode

cd /path/to/application
bundle exec ruby app.rb

Run in production mode

Set the $WOPR_ENV environment variable to run the application in production mode:

cd /path/to/application
WOPR_ENV=production bundle exec ruby app.rb

You should point your Apache or nginx web server to the application's public directory, which contains its static files.

Updating

Your deployment workflow should install new dependencies and re-build the web assets every time the frontend's source code is updated:

cd /path/to/application
bundle install
npm install
npm run build

Configuration

The following environment variables can be set to customize the application's behavior:

Variable	Default value	Description
WOPR_ENV	development	Set to production for deployment.
WOPR_PORT or PORT	4567	Port on which to listen to.
WOPR_REDIS_PREFIX	wopr:	Prefix prepended to all Redis database keys.
WOPR_REDIS_URL or REDIS_URL	redis://localhost:6379/0	Redis connection URL.