lichess.org/mobile

Lichess mobile is a cordova application that runs on the crosswalk webview. It is written in TypeScript and JavaScript. The rendering library is mithril.js. It uses babel, browserify and gulp as build tools. It talks to a native Stockfish engine, supporting multiple variants, through a cordova plugin. Multi-variant chess library is brought by a JavaScript version of scalachess.

Requirements

• node v6.x
• cordova v6.x

Android:

• the android SDK
• SDK packages API 23
• last version of Android SDK tools and platform tools
• android ndk for stockfish compilation
• make sure the sdk/tools/ directory is in your path, so you can use android command everywhere.

iOS:

• OS X and Xcode version 8.x

Build the web application

Make sure you installed all deps:

$ npm install

Then copy env.json.example to env.json and modify settings to link your app to a lichess server.

To build and watch for changes:

$ npm run watch

Build cordova application and run on device

Be sure to check requirements above.

See scripts defined in package.json for various environments.

Android

Plug your device with USB, or use an emulator. Then:

$ npm run android-stage

iOS

Plug your device with USB, or use an emulator. Then:

$ npm run ios-stage

Build stockfish

Android

Build the native code using:

ndk-build -C platforms/android

iOS

Through XCode, in the build settings menu:

• Set C++ Language Dialect option to C++11 value.
• Set C++ Standard Library option to lib++ value.

Advanced setup

See the wiki.

Contributing

Mithril views should be written with the hyperscript function (imported as h), and not JSX. Current JSX views are here for legacy reasons.

We use tslint to enforce some coding conventions. Before sending a pull request, please run the linter and ensure there is no error:

$ npm run lint