https://github.com/flaviodelgrosso/electron-forge-react-vite-boilerplate

Electron Forge boilerplate with React and powered by Vite.js
https://github.com/flaviodelgrosso/electron-forge-react-vite-boilerplate

boilerplate electron electron-forge react template vite

Last synced: 7 days ago
JSON representation

Electron Forge boilerplate with React and powered by Vite.js

• Host: GitHub
• URL: https://github.com/flaviodelgrosso/electron-forge-react-vite-boilerplate
• Owner: flaviodelgrosso
• License: mit
• Created: 2023-09-16T16:30:00.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-29T08:22:54.000Z (6 months ago)
• Last Synced: 2024-05-29T20:03:44.543Z (6 months ago)
• Topics: boilerplate, electron, electron-forge, react, template, vite
• Language: TypeScript
• Homepage:
• Size: 1.25 MB
• Stars: 14
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EFRV Boilerplate

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Introduction

This is a boilerplate project for Electron-Forge with React, Typescript, and Vite.

## Features

- Custom titlebar with control buttons and menus.

- Preload script with a minimal set of methods exposed from Electron's `ipcRenderer` to support communication to main process.

- Window state manager.

- Simple React application using SASS stylings.

- ESLint and Prettier configuration

- Husky to handle git hooks

## Screenshots

![Screenshot of the application on windows](./screenshots/window-win.png)

![Screenshot of the application on macOS](./screenshots/window-mac.png)

## Getting Started

To get started with this project, follow these steps:

1. Clone this repository.

2. Install dependencies with `yarn install`.

3. Run the application with `yarn start`.

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## License

This project is licensed under the terms of the [MIT license](./LICENSE).