react-gtk

Getting Started

1. Install the required dependencies

yarn add @reactgjs/react-gtk @reactgjs/renderer

2. Install the optional dependencies

• gjs-esm-types - adds type definitions for the GJS environment
• ts-node - allows you to start the project when written in TypeScript
• @swc/core - enabled swc compiler and speeds up development commands

yarn add -D gjs-esm-types ts-node @swc/core

3. Initiate the project Run the init command:

yarn react-gtk init

then open react-gtk.config.mjs file, change the app name and optionally adjust the project settings.

4. Start coding The entry file will be located in src/start.jsx.

Running in dev mode

yarn react-gtk start -m development -w

This command will start the project in development mode and watch for changes.

Building the project

yarn react-gtk build

This command will create a bundle file as well as other files meson needs to build the project. And then package it into a tarball file.

yarn react-gtk bundle

This command will create a standalone bundle file.

Documentation

Check out more of the React GTK features here