Open Knight

A cross-platform chess database and analysis application. ⚠️ SUPER ALPHA ⚠️

Documentation · Report Bug · Request Feature

Table of Contents

• Table of Contents
  • About the Project
    • Screenshots
    • Tech Stack
    • Features (more in development)
    • Environment Variables
  • Getting Started
    • Prerequisites
    • Run the project locally
  • Usage
  • Roadmap
  • Contributing
    • Code of Conduct
  • FAQ
  • License
  • Contact
  • Acknowledgements

About the Project

Screenshots

Tech Stack

Client

• Typescript
• Vue.js
• TailwindCSS
• PrimeVue Components

"Backend" (Tauri)

• Rust
• Diesel

Database

• SQLite

DevOps

• TODO

Features (more in development)

• Import PGN files
• Chess game viewer
• Game/Move annotations
• Move tree/list
• Theme support

Environment Variables

Currently no environment variables are needed. You can modify the default database location in the src-tauri/.env file.

Getting Started

Prerequisites

This project uses npm as package manager.

Tauri uses rust and cargo to build the application. Instructions for installing rust can be found here.

Run the project locally

Clone the project

git clone https://github.com/reidpritchard/open-knight.git

Go to the project directory

  cd open-knight

Install dependencies

  npm install

Run database migrations

  npm run db:migrate

Run the whole project in development mode

  npm run tauri dev

Run only the frontend

  npm run dev

Usage

The project is under active development and new features are being added frequently. Currently it's not recommended to use the application in a production environment.

Roadmap

Listed in no particular order and likely to change (also the checked items are not stable, I keep breaking things):

• PGN Parsing
• Import PGN files
• Chess game viewer
• Basic UI layout customization
• Game/Move annotations
• Move tree/list
• Theme support
• UCI support
• Drag and drop imports
• PGN export
• Position search
• Tactics/Motif search
• Openings support

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Code of Conduct

Please read the Code of Conduct

FAQ

• Does this project support X feature?

  • Likely not. It's still in early alpha, but you can always open an issue or submit a PR!

• How can I help?

  • Any contributions are welcome! See the Contributing section for more information.

License

The project uses the PolyForm Noncommercial 1.0.0 License. See the license file for more information.

Reason for license

I chose this license because I want to keep the project open source, but also want to ensure that it's not used in a way that is harmful to the development of the project. For example, I don't want a company making a profit off of the project without contributing back. I am open to more traditional OSI approved licenses in the future, but for now this one allows me to keep more control over the project. I'd rather move from this license to something more permissive in the future rather than the other way around.

Contact

Reid Pritchard - @reidpritchard - [email protected]

Project Link: https://github.com/reidpritchard/open-knight

Acknowledgements

• Shields.io
• Awesome README
• Readme Template
• Tauri