https://github.com/soorajshankar/test_electron

https://github.com/soorajshankar/test_electron

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/soorajshankar/test_electron
• Owner: soorajshankar
• License: mit
• Created: 2021-05-16T07:12:41.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-16T07:12:43.000Z (about 4 years ago)
• Last Synced: 2025-01-18T04:11:48.924Z (5 months ago)
• Language: TypeScript
• Size: 641 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Electron 11 + TypeScript 4.0 + Vite 2 + React 17 + Tailwind 2 + twstyled starter

![Electron + Vite + React Starter](https://github.com/twstyled/electron-vite-react/blob/main/public/screenshot.png)

Blazing fast Electron starter including 

- [x] `Vite` for next generation frontend tooling

- [x] `Typescript`

- [x] `ESBuild` for building all assets including the main process

- [x] `React` as the front end framework

- [x] `Tailwind CSS` for styling without templates

- [x] `twstyled` tailwind compiler for no PostCSS processing and full-featured CSS in JS

- [x] `Framer Motion` for animation transitions

- [x] `React fast refresh` for hot module reloading

- [x] `electron-builder` and `electron-notarize` for distribution release

- [x] Zero dependency on Vue, tsc or styled-components, emotion or other runtime CSS in JS (but supports all the same API)

Configured with best practices.

## Installation

`yarn`

## Development

`yarn dev`

## Build

`yarn build`

## Release

Add any configuration to the `build` section of `package.json`, add an `.env-secrets.json` file in the `.config` folder with any environment secrets that you need for your publisher, and then run 

`yarn publish`

# Prior art

Inspired by https://github.com/appinteractive/electron-vite-tailwind-starter and https://github.com/maxstue/vite-reactts-electron-starter

# License

MIT