{"id":21908624,"url":"https://github.com/reidpritchard/open-knight","last_synced_at":"2025-06-28T13:36:57.250Z","repository":{"id":264972345,"uuid":"872182511","full_name":"ReidPritchard/open-knight","owner":"ReidPritchard","description":"Open Knight is a modern cross-platform chess database and analysis application.  ⚠️ Heavy Development ⚠️","archived":false,"fork":false,"pushed_at":"2025-06-23T15:44:36.000Z","size":7320,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-23T16:57:12.499Z","etag":null,"topics":["analysis","chess","database","tauri"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ReidPritchard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-14T01:24:10.000Z","updated_at":"2025-06-10T22:30:54.000Z","dependencies_parsed_at":"2024-11-27T02:30:48.918Z","dependency_job_id":"6b08a300-1892-42dd-a711-444aa46b1f55","html_url":"https://github.com/ReidPritchard/open-knight","commit_stats":null,"previous_names":["reidpritchard/open-knight"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ReidPritchard/open-knight","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReidPritchard%2Fopen-knight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReidPritchard%2Fopen-knight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReidPritchard%2Fopen-knight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReidPritchard%2Fopen-knight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ReidPritchard","download_url":"https://codeload.github.com/ReidPritchard/open-knight/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReidPritchard%2Fopen-knight/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262438667,"owners_count":23311195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","chess","database","tauri"],"created_at":"2024-11-28T17:13:00.214Z","updated_at":"2025-06-28T13:36:57.243Z","avatar_url":"https://github.com/ReidPritchard.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n  \u003cimg src=\"docs/assets/logo.png\" alt=\"logo\" width=\"200\" height=\"auto\" /\u003e\n  \u003ch1\u003eOpen Knight\u003c/h1\u003e\n  \n  \u003cp\u003e\n    A cross-platform chess database and analysis application. ⚠️ SUPER ALPHA ⚠️\n  \u003c/p\u003e\n  \n\u003c!-- Badges --\u003e\n\u003cp\u003e\n  \u003ca href=\"https://github.com/reidpritchard/open-knight/graphs/contributors\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/contributors/reidpritchard/open-knight\" alt=\"contributors\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/last-commit/reidpritchard/open-knight\" alt=\"last update\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/reidpritchard/open-knight/network/members\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/forks/reidpritchard/open-knight\" alt=\"forks\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/reidpritchard/open-knight/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/reidpritchard/open-knight\" alt=\"stars\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/reidpritchard/open-knight/issues/\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/reidpritchard/open-knight\" alt=\"open issues\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch4\u003e\n    \u003ca href=\"https://github.com/reidpritchard/open-knight\"\u003eDocumentation\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://github.com/reidpritchard/open-knight/issues/\"\u003eReport Bug\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://github.com/reidpritchard/open-knight/issues/\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/h4\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\u003c!-- Table of Contents --\u003e\n\n# Table of Contents\n\n\u003c!-- @import \"[TOC]\" {cmd=\"toc\" depthFrom=1 depthTo=6 orderedList=false} --\u003e\n\n\u003c!-- code_chunk_output --\u003e\n\n- [Table of Contents](#table-of-contents)\n  - [About the Project](#about-the-project)\n    - [Screenshots](#screenshots)\n    - [Tech Stack](#tech-stack)\n    - [Features](#features)\n  - [Getting Started](#getting-started)\n    - [Prerequisites](#prerequisites)\n    - [Run the project locally](#run-the-project-locally)\n  - [Usage](#usage)\n  - [Roadmap](#roadmap)\n  - [Contributing](#contributing)\n    - [Code of Conduct](#code-of-conduct)\n  - [FAQ](#faq)\n  - [License](#license)\n  - [Contact](#contact)\n  - [Acknowledgements](#acknowledgements)\n\n\u003c!-- /code_chunk_output --\u003e\n\n\u003c!-- About the Project --\u003e\n\n## About the Project\n\n\u003c!-- Screenshots --\u003e\n\n### Screenshots\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"docs/assets/UI-May28-2025.png\" alt=\"Screenshot of the current Open Knight UI\" /\u003e\n\u003c/div\u003e\n\n\u003c!-- TechStack --\u003e\n\n### Tech Stack\n\n\u003cdetails\u003e\n  \u003csummary\u003eClient\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://www.typescriptlang.org/\"\u003eTypescript\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://vuejs.org/\"\u003eVue.js\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://tailwindcss.com/\"\u003eTailwindCSS\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://daisyui.com/\"\u003eDaisyUI\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\"Backend\" (Tauri)\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://www.rust-lang.org/\"\u003eRust\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://www.sea-ql.org/SeaORM/\"\u003eSeaORM\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDatabase\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://www.sqlite.org/\"\u003eSQLite\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003c!-- Features --\u003e\n\n### Features\n\n- Import PGN files\n- Chess game viewer and editor\n- Move tree/list\n- Multiple board support\n- UCI engine support\n\n\u003csmall\u003e\n  \u003ci\u003e\n    Some features are not fully implemented and are in development, however the core functionality is there.\n  \u003c/i\u003e\n\u003c/small\u003e\n\n\u003c!-- Env Variables --\u003e\n\n### Environment Variables\n\nCurrently no environment variables are used.\n\n\u003c!-- Getting Started --\u003e\n\n## Getting Started\n\n\u003c!-- Prerequisites --\u003e\n\n### Prerequisites\n\nThis project uses `npm` as package manager.\n\nTauri uses `rust` and `cargo` to build the application. Instructions for installing `rust` can be found [here](https://www.rust-lang.org/tools/install).\n\n\u003c!-- Installation --\u003e\n\n### Run the project locally\n\nClone the project\n\n```bash\ngit clone https://github.com/reidpritchard/open-knight.git\n```\n\nGo to the project directory\n\n```bash\n  cd open-knight\n```\n\nInstall dependencies\n\n```bash\n  npm install\n```\n\nSetup Typia and shared types\n\n```bash\n  npm run prepare\n```\n\nRun the whole project in development mode\n\n```bash\n  npm run tauri dev\n```\n\nRun only the frontend\n\n```bash\n  npm run dev\n```\n\n\u003c!-- Usage --\u003e\n\n## Usage\n\nThe 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 or with data without backing up first.\n\n\u003c!-- Roadmap (in no particular order) --\u003e\n\n## Roadmap\n\nListed in no particular order and likely to change (also the checked items are not stable, I keep breaking things):\n\n- [x] PGN Parsing\n- [x] Import PGN files\n- [x] Chess game viewer\n- [x] Basic UI layout customization\n- [x] Move tree/list\n- [x] UCI support\n- [x] Theme support\n- [ ] Game/Move annotations (In Progress)\n- [ ] Drag and drop imports\n- [ ] PGN export\n- [ ] Position search\n- [ ] Tactics/Motif search\n- [ ] Openings support\n\n\u003c!-- Contributing --\u003e\n\n## Contributing\n\nContributions are always welcome!\n\nSee `contributing.md` for ways to get started.\n\n\u003c!-- Code of Conduct --\u003e\n\n### Code of Conduct\n\nPlease read the [Code of Conduct](https://github.com/reidpritchard/open-knight/blob/main/docs/CODE_OF_CONDUCT.md)\n\n\u003c!-- FAQ --\u003e\n\n## FAQ\n\n- Does this project support X feature?\n\n  - Likely not. It's still in early alpha, but you can always open an issue or submit a PR!\n\n- How can I help?\n\n  - Any contributions are welcome! See the [Contributing](https://github.com/reidpritchard/open-knight/blob/main/CONTRIBUTING.md) section for more information.\n\n\u003c!-- License --\u003e\n\n## License\n\nThe project uses the [PolyForm Noncommercial 1.0.0 License](https://github.com/reidpritchard/open-knight/blob/main/docs/LICENSE.md). See the license file for more information.\n\n\u003cdetails\u003e\n\u003csummary\u003eReason for license\u003c/summary\u003e\nI 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.\n\u003c/details\u003e\n\n\u003c!-- Contact --\u003e\n\n## Contact\n\nReid Pritchard - [@reidpritchard](https://github.com/reidpritchard) - \u003creidprichard99@gmail.com\u003e\n\nProject Link: [https://github.com/reidpritchard/open-knight](https://github.com/reidpritchard/open-knight)\n\n\u003c!-- Acknowledgments --\u003e\n\n## Acknowledgements\n\n- [Shields.io](https://shields.io/)\n- [Awesome README](https://github.com/matiassingers/awesome-readme)\n- [Readme Template](https://github.com/othneildrew/Best-README-Template)\n- [Tauri](https://github.com/tauri-apps/tauri)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freidpritchard%2Fopen-knight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freidpritchard%2Fopen-knight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freidpritchard%2Fopen-knight/lists"}