open-index/open-npm huggingface dataset:
npm package: @react-appkit/compiler
Description: This is the CLI tool for React AppKit. It's used to build, start, run in dev mode (including hot reloading), and package the app for distribution.
Latest version: 1.0.8

# @react-appkit/compiler

This is the CLI tool for React AppKit. It's used to build, start, run in dev mode (including hot reloading), and package the app for distribution.

The CLI uses [Vite](https://vitejs.dev/) under the hood to build the app, along with some custom plugins.

The CLI also uses [Electron Builder](https://www.electron.build/) to package the app for distribution when running the `pack` command.

## Project Structure
There are four main entrypoints:
- `src/build.ts`: Builds the app for production.
- `src/start.ts`: Starts the app in dev mode.
- `src/dev.ts`: Starts the app in dev mode with hot reloading.
- `src/pack.ts`: Packages the app for distribution.

Aside from these, there are two other parts:
- `src/builders/*` - various build functions for different parts of the app.
- `src/utils/vite/*` - custom Vite plugins used by the different builders.
- `templates/*` - templates for virtual entrypoints that are used as binding points between user code and the runtime.

## Build Output
The build step creates multiple entrypoints for the app, each for a different command, under the `dist/binaries` directory.
The resulting code is CJS, so it can be used in most Node.js environments.

Learn more about React Appkit: https://github.com/illberoy/react-appkit
npm package: @react-appkit/eslint-config
Description: This is a shared ESLint config. This is the recommended config for all React AppKit projects.
Latest version: 1.0.8

# @react-appkit/eslint-config

This is a shared ESLint config. This is the recommended config for all React AppKit projects.

This config is also used by internal modules.

Learn more about React Appkit: https://github.com/illberoy/react-appkit
npm package: @react-appkit/runtime
Description: This module contains the runtime code for React AppKit. Essentially, it serves as the "engine" that wraps around the user's app code and runs it.
Latest version: 1.0.8

# @react-appkit/runtime

This module contains the runtime code for React AppKit. Essentially, it serves as the "engine" that wraps around the user's app code and runs it.

Currently, it's based on the [Electron](https://www.electronjs.org/) framework, but it aims to abstract this detail away, so that if one day we decide to switch to another framework or runtime, user code should still be compatible.

## Project Structure
The project consists of three main parts:

- `src/main`: This is the main process code that operates within the Node process of the application. It manages launching the app, handling user actions, managing the tray, creating the application menu, window management, and more.
- `src/renderer`: This refers to the renderer process code, which operates independently in each open window. It runs in a browser context and does not have direct access to Node APIs. This component is responsible for UI rendering, routing, and providing the "bridge" IPC API for communication between the main process and the renderer process.
- `src/shared`: This includes the shared code that is utilized by both the main and renderer processes.

## Build Output
No build step is required; this library is designed to be used directly by the app, and is built and bundled alongside it.

Learn more about React Appkit: https://github.com/illberoy/react-appkit
npm package: @react-appkit/sdk
Description: This library provides public APIs to assist in developing applications using React AppKit.
Latest version: 1.0.8

# @react-appkit/sdk

This library provides public APIs to assist in developing applications using React AppKit.

The key distinction between this library and the runtime is that this library is intended for direct use by app developers, while the runtime is designed for internal use only and isn't available to app developers.

## Project Structure
The project comprises multiple entry points, each exporting a unique set of APIs. To explore these, please consult the inline JSDoc documentation for each module, located in the "src" folder.

## Build Output
No build step is required; this library is designed to be used directly in app code and is built and bundled alongside the app.

Learn more about React Appkit: https://github.com/illberoy/react-appkit