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 is used for UI components.
Setup
- Clone repository to your local machine.
- Install npm dependencies:
$ npm install
Debugging
- Run the following command. This compiles the project as well as starts a webpack dev server to enable auto reloading.
$ npm run dev:react
- 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
- 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.