Skip to content

react-gjs/react-gtk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ba9dd60 · Dec 19, 2024
Dec 10, 2024
Dec 6, 2022
Dec 12, 2024
Dec 10, 2024
Dec 14, 2024
May 14, 2024
Dec 12, 2024
Dec 19, 2024
Dec 13, 2024
Dec 19, 2024
Dec 6, 2022
Feb 6, 2023
Dec 14, 2024
Feb 6, 2023
Dec 10, 2024
Dec 6, 2022
Dec 19, 2024
May 14, 2024
May 14, 2024
Dec 10, 2024
Dec 10, 2024
May 14, 2024
Dec 17, 2024
Dec 10, 2024
May 14, 2024
Dec 13, 2024

Repository files navigation

react-gtk

Getting Started

  1. Make sure you have Node.js installed on your system, it's necessary for the development.

  2. Install the required dependencies

yarn add @reactgjs/react-gtk
# or
npm install @reactgjs/react-gtk
  1. 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 when using TypeScript
yarn add -D gjs-esm-types ts-node @swc/core
# or
npm install -D gjs-esm-types ts-node @swc/core
  1. Initiate the project

Run the init command:

yarn react-gtk init
# or
npx react-gtk init

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

  1. Start coding

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

Running in dev mode

yarn start
# or
npm run start

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

Building the project

yarn build
# or
npm run 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 bundle
# or
npm run bundle

This command will create a standalone bundle file.

Documentation

Check out more of the React GTK features here