electron-toolkit - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #machine-learning #rust #deep-learning #docker #macos #nodejs #cli #kubernetes #openai #open-source

electron-toolkit

(★ 214)

Toolkit for Electron

File Explorer

Download Latest Version (.zip)

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - release-tag.yml
- commit-convention.md
- PULL_REQUEST_TEMPLATE.md
- extensions.json
- settings.json
- LICENSE
- - CHANGELOG.md
  - index.d.ts
  - index.js
  - LICENSE
  - package.json
  - README.md
- - CHANGELOG.md
  - index.d.ts
  - index.js
  - LICENSE
  - package.json
  - README.md
- - CHANGELOG.md
  - eslint-base.js
  - eslint-recommended-type-checked.js
  - eslint-recommended.js
  - eslint-typescript.js
  - index.d.ts
  - index.js
  - LICENSE
  - package.json
  - README.md
- - index.html
  - package.json
  - README.md
  - tsconfig.node.json
  - tsconfig.web.json
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - rollup.config.ts
  - tsconfig.json
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - tsconfig.json
  - tsconfig.node.json
  - tsconfig.web.json
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - rollup.config.ts
  - tsconfig.json
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - rollup.config.ts
  - tsconfig.json
- verifyCommit.js
.editorconfig
.gitignore
.npmrc
.prettierignore
.prettierrc.yaml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
eslint.config.mjs
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
tsconfig.base.json
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/alex8088/electron-toolkit

Downloads the entire project code from GitHub to your computer.

cd electron-toolkit

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# electron-toolkit

<p>
  <img src="https://img.shields.io/badge/node->14.18.0-blue.svg" alt="node" />
  <img src="https://img.shields.io/badge/electron->13.0.0-9feaf9.svg" alt="electron" />
</p>

> Toolkit for Electron

## Packages

| Package                                                                     | Description                                               | Version                                                                                                                                                                |
| --------------------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [@electron-toolkit/eslint-config](packages/eslint-config)                   | ESLint config for Electron projects                       | [![eslint-config version](https://img.shields.io/npm/v/@electron-toolkit/eslint-config.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/eslint-config/CHANGELOG.md)                            |
| [@electron-toolkit/eslint-config-ts](packages/eslint-config-ts)             | ESLint config for Electron-TypeScript projects            | [![eslint-config-ts version](https://img.shields.io/npm/v/@electron-toolkit/eslint-config-ts.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/eslint-config-ts/CHANGELOG.md)                   |
| [@electron-toolkit/eslint-config-prettier](packages/eslint-config-prettier) | ESLint config with Prettier support for Electron projects | [![eslint-config-prettier version](https://img.shields.io/npm/v/@electron-toolkit/eslint-config-prettier.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/eslint-config-prettier/CHANGELOG.md) |
| [@electron-toolkit/utils](packages/utils)                                   | Utils for Electron main process                           | [![utils version](https://img.shields.io/npm/v/@electron-toolkit/utils.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/utils/CHANGELOG.md)                                                    |
| [@electron-toolkit/tsconfig](packages/tsconfig)                             | TSConfigs for Electron projects to extend                 | [![tsconfig version](https://img.shields.io/npm/v/@electron-toolkit/tsconfig.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/tsconfig/CHANGELOG.md)                                           |
| [@electron-toolkit/typed-ipc](packages/typed-ipc)                           | Type-safe Electron IPC                                    | [![ipc version](https://img.shields.io/npm/v/@electron-toolkit/typed-ipc.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/typed-ipc/CHANGELOG.md)                                              |
| [@electron-toolkit/preload](packages/preload)                               | Expose Electron APIs to renderer process                  | [![preload version](https://img.shields.io/npm/v/@electron-toolkit/preload.svg?label=%20)](https://raw.githubusercontent.com/alex8088/electron-toolkit/master/packages/preload/CHANGELOG.md)                                              |

## Contribution

See [Contributing Guide](https://github.com/alex8088/electron-toolkit/blob/master/CONTRIBUTING.md).

## License

MIT