https://github.com/misprit7/goodknight
A chess database program written with Electron, React and Typescript that is definitely not a rip off of ChessBase.
https://github.com/misprit7/goodknight
chess electron react typescript
Last synced: 5 months ago
JSON representation
A chess database program written with Electron, React and Typescript that is definitely not a rip off of ChessBase.
- Host: GitHub
- URL: https://github.com/misprit7/goodknight
- Owner: misprit7
- Created: 2021-07-13T07:32:18.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-24T17:47:25.000Z (over 3 years ago)
- Last Synced: 2024-11-14T13:24:07.321Z (7 months ago)
- Topics: chess, electron, react, typescript
- Language: TypeScript
- Homepage:
- Size: 3.98 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GoodKnight
Chess Database and Analysis Software
GoodKnight is an open source project that acts as a chess database manager and analysis tool. It's goal is to provide the powerful functionality of ChessBase or SCID except with a more modern and friendly user interface.
Electron is used to make the desktop application, with React being the framework used in the frontend. Almost everything is programmed in TypeScript, and [antd](https://ant.design/) is used for UI components.
## Setup
1. Clone repository to your local machine.
2. Install npm dependencies:
```
$ npm install
```
## Debugging
1. Run the following command. This compiles the project as well as starts a webpack dev server to enable auto reloading.
```
$ npm run dev:react
```
2. Go to the debug tab of VSCode and click on the green arrow next to the run Electron: All button.
Alternatively you can run the following, although you won't get any of the further debugging capabilities:
```
$ npm run start:electron
```
3. Set breakpoints. The two debug profiles should handle both renderer and main processes, so you should be able to set breakpoints for either one. Setting this up took inspiration from [this](https://github.com/abartho/electron-typescript-vscode).