Skip to content

Latest commit

 

History

History
112 lines (68 loc) · 2.65 KB

README.md

File metadata and controls

112 lines (68 loc) · 2.65 KB

Logo

Electron-Typescript Starter

Electron Logo

🚀 A production-ready starter for building cross-platform desktop applications with Electron.

Built With

  • Electron
  • Vue
  • Vite
  • TypeScript

Getting Started

1. Download starter and install dependencies

Clone this repository:

git clone [email protected]:jsam07/electron-vue-ts-starter.git

Install npm dependencies:

cd  electron-vue-ts-starter
npm install

2. Start Desktop Application in Development Mode

npm run dev

3. Production Builds

Edit the electron-builder.json file to accommodate your application. See Electron Builder to package and build a ready for distribution Electron app for macOS, Windows and Linux with “auto update” support out of the box.

Run build command on the appropriate OS

npm run release:linux
npm run release:mac
npm run release:win

Usage

--

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Contributors

This project exists thanks to all the people who contribute.

License

GPL-3.0 © Minerva-MD

Acknowledgments