Skip to content

ksxelectronapps/lichess-app

Repository files navigation

lichess-app

Travis Build Status AppVeyor Build status JavaScript Style Guide

A desktop client for lichess.org

Feature

Download

Go to GitHub Release page

To Do

  • Lichess icon
  • Tray icon
  • Customize menu bar
  • Webcontent proxy
  • Background page
  • Create 404 page
  • Cache Credentials
  • Handle notifications
  • Upload to AUR

Development

Requirements

  • NodeJS ≥ 6.0.0, and npm (mandatory)
  • BASH environment (mandatory)
  • UNIX-like environment (optional, recommended)

Preparation

npm install

Test and build

Quick checking

Check code style and small stuffs

npm test

Start application

Open application window and interact with it

npm start

Dist without packaging

Create application directories without packaging

OPTIONS='linux macos windows' npm run dist # If success, open 'dist' folder to see the result

Create packages

Create distributable packages (files)

OPTIONS='linux macos windows' npm run pack # If success, open 'dist' folder to see the result

Clean the mess

Remove all "gitignored" files/folders (dist, *.tmp, *.log, etc.)

npm run clean

Contributing

This project uses Feross's JavaScript code standard

JavaScript Style Guide

License

MIT