Skip to content

A tool to help audit a website’s colour contrast

Notifications You must be signed in to change notification settings

rikschennink/kontraster

 
 

Repository files navigation

Kontraster

Kontraster is a tool to help audit text colour contrast on websites.

Screenshot of Kontraster

Prerequisites

Installation

To install Kontraster, execute the following lines in terminal:

# Download Kontraster
git clone https://github.com/timseverien/kontraster.git
cd kontraster

# Install dependencies
npm install
# Build required assets
npm run build --production

# Start server
./kontraster

After starting the server by executing ./kontraster, a localhost address should appear in the console. Open that address in the browser. The rest should be self-explanatory.

CLI Usage

$ ./kontraster [options]

Options

  • --port, -p: The port to run the server on (default: 3000)
  • --help, -h: The help message

About

A tool to help audit a website’s colour contrast

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 63.6%
  • GLSL 17.2%
  • CSS 13.9%
  • HTML 5.3%