2017-05-28 10:25:40 -06:00
[lichess.org ](https://lichess.org )
==================================
2012-02-19 04:55:30 -07:00
2017-05-28 10:25:40 -06:00
[![Build Status ](https://travis-ci.org/ornicar/lila.svg?branch=master )](https://travis-ci.org/ornicar/lila)
[![Crowdin ](https://d322cqt584bo4o.cloudfront.net/lichess/localized.svg )](https://crowdin.com/project/lichess)
2017-07-13 07:58:49 -06:00
[![Twitter ](https://img.shields.io/badge/Twitter-%40lichess-blue.svg )](https://twitter.com/lichess)
2016-12-15 12:31:26 -07:00
2017-09-12 10:47:45 -06:00
< img src = "https://raw.githubusercontent.com/ornicar/lila/master/public/images/home-bicolor.png" alt = "lichess.org" / >
2014-12-24 05:18:59 -07:00
2017-01-08 15:45:30 -07:00
Lila (li[chess in sca]la) is a free online chess game server focused on [realtime ](https://lichess.org/games ) gameplay and ease of use.
2016-06-16 05:24:33 -06:00
It features a [search engine ](https://lichess.org/games/search ),
[computer analysis ](https://lichess.org/ief49lif ) distributed with [fishnet ](https://github.com/niklasf/fishnet ),
[tournaments ](https://lichess.org/tournament ),
[simuls ](https://lichess.org/simul ),
[forums ](https://lichess.org/forum ),
[teams ](https://lichess.org/team ),
[tactic trainer ](https://lichess.org/training ),
a [mobile app ](https://lichess.org/mobile ),
2016-12-07 01:19:11 -07:00
and a [shared analysis board ](https://lichess.org/study ).
2017-05-28 10:25:40 -06:00
The UI is available in more than [80 languages ](https://crowdin.com/project/lichess ) thanks to the community.
2016-06-16 05:24:33 -06:00
Lichess is written in [Scala 2.11 ](https://www.scala-lang.org/ ),
2017-01-20 02:37:31 -07:00
and relies on [Play 2.4 ](https://www.playframework.com/ ) for the routing, templating, and JSON.
2016-06-16 05:24:33 -06:00
Pure chess logic is contained in [scalachess ](https://github.com/ornicar/scalachess ) submodule.
2018-01-31 09:00:44 -07:00
The server is fully asynchronous, making heavy use of Scala Futures and [Akka 2 actors ](http://akka.io ).
2017-09-12 10:47:45 -06:00
Lichess talks to [Stockfish ](http://stockfishchess.org/ ) deployed in an [AI cluster ](https://github.com/niklasf/fishnet ) of donated servers.
2018-08-25 02:05:37 -06:00
It uses [MongoDB ](https://mongodb.org ) to store more than 800 million games, which are indexed by [elasticsearch ](http://elasticsearch.org ).
HTTP requests and websocket connections are proxied by [nginx ](http://nginx.org ).
2017-09-12 10:47:45 -06:00
The web client is written in [TypeScript ](https://typescriptlang.org ) and [snabbdom ](https://github.com/snabbdom/snabbdom ).
2016-06-16 05:24:33 -06:00
The [blog ](https://lichess.org/blog ) uses a free open content plan from [prismic.io ](https://prismic.io ).
2018-11-02 06:50:59 -06:00
All rated games are published in a [free PGN database ](https://database.lichess.org ).
2018-08-25 02:05:37 -06:00
Browser testing done with [![Browserstack ](https://raw.githubusercontent.com/ornicar/lila/master/public/images/browserstack.png )](https://www.browserstack.com).
2018-01-31 09:00:44 -07:00
Please help us [translate lichess with Crowdin ](https://crowdin.com/project/lichess ).
2012-04-25 14:15:35 -06:00
2017-09-12 10:47:45 -06:00
[Join us on discord ](https://discord.gg/hy5jqSs ) or in the #lichess freenode IRC channel for more info.
2017-05-28 10:25:40 -06:00
Use [GitHub issues ](https://github.com/ornicar/lila/issues ) for bug reports and feature requests.
2013-06-08 05:25:27 -06:00
2012-06-18 06:36:49 -06:00
Installation
2013-06-08 05:25:27 -06:00
------------
2012-04-25 14:15:35 -06:00
2016-06-16 05:24:33 -06:00
> If you want to add a live chess section to your website, you are welcome to [embed lichess](https://lichess.org/developers) into your website. It's very easy to do.
2014-02-22 19:24:48 -07:00
2016-06-16 05:24:33 -06:00
> This project source code is open for other developers to have an example of non-trivial scala/play2/mongodb application. You're welcome to reuse as much code as you want for your projects and to get inspired by the solutions I propose to many common web development problems. But please don't just create a public lichess clone. Instead, [embed lichess using an <iframe>](https://lichess.org/developers) into your website.
2013-09-12 09:06:56 -06:00
2018-01-31 09:00:44 -07:00
> Also note that while I provide the source code, I do **not** offer support for your lichess instance. I will probably ignore any question about lichess installation and runtime issues.
2013-06-08 05:25:27 -06:00
2014-05-11 12:02:42 -06:00
## HTTP API
2018-04-03 17:11:41 -06:00
Feel free to use [lichess API ](https://lichess.org/api ) in your applications and websites.
2013-12-31 03:45:37 -07:00
2013-06-08 05:25:27 -06:00
Credits
-------
2016-06-16 05:24:33 -06:00
See the [lichess Thanks page ](https://lichess.org/thanks )
2016-02-16 02:11:51 -07:00
Supported browsers
------------------
2017-03-19 08:43:16 -06:00
- [Chrome ](https://www.google.com/chrome ) or [Chromium ](https://www.chromium.org/getting-involved/download-chromium ), 1 year old or newer (fastest local analysis!)
- [Firefox ](https://www.mozilla.org/firefox ), 1 year old or newer (second fastest local analysis!)
- Opera 34 and newer (meh)
- Safari 9 and newer (boo)
- Microsoft Edge (yuck)
- Internet Explorer 11 (eew)
Older browsers will not work. For your own sake, please upgrade.
Security and performance, think about it!
2016-03-17 13:35:32 -06:00
2017-07-17 10:26:42 -06:00
License
2016-03-17 13:35:32 -06:00
-------
2016-10-12 11:18:08 -06:00
Lila is licensed under the GNU Affero General Public License 3 or any later
version at your choice with an exception for Highcharts. See COPYING for
details.