https://github.com/react-gjs/react-gtk
https://github.com/react-gjs/react-gtk
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/react-gjs/react-gtk
- Owner: react-gjs
- License: mit
- Created: 2022-12-06T14:32:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-17T12:25:28.000Z (over 1 year ago)
- Last Synced: 2025-04-05T22:32:43.008Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 5.12 MB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```bash
yarn add @reactgjs/react-gtk
# or
npm install @reactgjs/react-gtk
```
3. 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
```bash
yarn add -D gjs-esm-types ts-node @swc/core
# or
npm install -D gjs-esm-types ts-node @swc/core
```
4. Initiate the project
Run the init command:
```bash
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.
5. Start coding
The entry file will be located in `src/start.jsx`.
## Running in dev mode
```bash
yarn start
# or
npm run start
```
This command will start the project in development mode and watch for changes.
## Building the project
```bash
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.
```bash
yarn bundle
# or
npm run bundle
```
This command will create a standalone bundle file.
## Documentation
Check out more of the React GTK features [here](./docs)