Skip to content
A Swiss-style chess tournament management app.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__ cleanup Jul 17, 2019
assets
graphics-src refactoring and bugfixes Jul 15, 2019
public logo SVG changes Jun 27, 2019
src
.editorconfig updates Jul 11, 2019
.eslintrc.json updates Jul 8, 2019
.gitignore began reasonml conversion Jun 30, 2019
.stylelintignore
.stylelintrc.json
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE 📄 updated license to AGPL Jun 16, 2019
README.md
TODO.md cleanup Jul 16, 2019
TODO_Pairing_Scoring.md wrapping up intitial conversion Jul 12, 2019
bsconfig.json
package-lock.json
package.json

README.md

Logo

Coronate

Coronate is a web app for managing Swiss-style chess tournaments.

🧐 About

Coronate is a free alternative to pricey professional tournament software. Anyone, even a tournament newbie with a locked-down public-access computer, can use it to run their tournament.

👉 Click here for a live demo ♟

Read more about how to use the app here. It's mostly version 1.0 feature-complete, but it is definitely still in beta.

⚠️ The master branch is unstable ⚠️

I recently rewrote the JavaScript code into ReasonML. Although Reason is inherently safer, the new code hasn't been tested as much as the previous JS code. There are most likely some bugs lurking. Use at your own peril.

🏁 Getting Started

These are the basic steps you'll need to follow to get a development copy of Coronate running on your machine:

Prerequisites

You'll need Node.js version 10. Coronate probably runs on other versions too, but it's not tested on them.

Installing

1: Grab the code

For most people, the easiest method is to click the "Clone or Download" button on this project's GitHub homepage.

If you have Git installed, you can also run:

git clone https://github.com/johnridesabike/coronate.git

If you want to make your own changes, then it's recommended to fork the repository on GitHub and clone your forked version.

2: Install the dependencies

Once you have a local copy of the code, run this command in the project's directory to install its dependencies:

npm install

🔧 Running the tests

The current tests are incomplete and only test a few of the most fragile functions.

You can run the tests with the command:

npm test

🎈 Usage

Coronate works completely in your local browser. You can run your live demo of it with the command:

npm start

and then open this URL: http://localhost:3000.

Because it keeps your data in your browser's storage, be mindful that data loss can happen unexpectedly depending on your settings. The app's "options" page has a button to back up your data in an external file.

To use the standalone Electron version, run:

npm run start:electron

Or if you're on Windows, then run:

npm run start:electron-win

The Electron functionality is almost identical to the web version. The biggest difference is that it stores your data separately from your browser.

🚀 Deployment

To create an optimized version that can be uploaded to your own website, run:

npm run build

To create a standalone Electron app for Mac and Windows, run:

npm run build:electron-all

If you're on a Windows system, run this to only build the Windows version:

npm run build:electron-win

The Windows version is "portable." It has no installer and stores all of its data in the same folder as its executable.

Linux builds have not been tested.

⛏️ Built Using

✍️ Authors

🎉 Acknowledgements

The three "kings" in the logo are derived from the Mérida chess font, which was informally licensed as "freeware."

Some human interface decisions (colors, buttons, etc.) are based on the Photon Design System for an elegant, OS-neutral, appearance.

You can’t perform that action at this time.