https://github.com/aabuhijleh/echo
Echo's Electron-based desktop application
https://github.com/aabuhijleh/echo
Last synced: about 2 months ago
JSON representation
Echo's Electron-based desktop application
- Host: GitHub
- URL: https://github.com/aabuhijleh/echo
- Owner: aabuhijleh
- License: cc0-1.0
- Created: 2020-03-01T18:28:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T08:45:12.000Z (over 2 years ago)
- Last Synced: 2025-02-05T05:34:22.081Z (4 months ago)
- Language: TypeScript
- Size: 1.1 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Electron TypeScript Quick Start
> This template is based on the official [electron-quick-start](https://github.com/electron/electron-quick-start) repository (but with typescript + prettier + electron-builder)
## How to use?
```sh
# install dependencies
$ npm install
# compile typescript files
$ npm run compile
# watch typescript files for changes (auto compilation)
$ npm run watch
# run the app
$ npm start
# create distributable packages for specific platforms
$ npm run dist-linux
$ npm run dist-mac
$ npm run dist-windows
```
## Directory Structure
.
├── electron-builder.json (electron-builder configuration)
├── .github (github CI configuration)
│ └── workflows
│ └── nodejs.yml
├── .gitignore
├── .huskyrc.json (Husky configuration)
├── LICENSE.md
├── .lintstagedrc.json (lint-staged configuration)
├── package.json
├── package-lock.json
├── .prettierignore
├── README.md
├── src (typescript files go here)
│ ├── main.ts
│ ├── preload.ts
│ └── renderer.ts
├── .stylelintrc.json (stylelint configuration)
├── tsconfig.json (typescript compiler options)
├── tslint.json (tslint configuration)
├── views (html, css files go here)
│ ├── index.css
│ └── index.html
└── .vscode
├── launch.json (debugger configuration)
└── settings.json (workspace settings)
## Resources
- [Electron docs](https://www.electronjs.org/docs)
- [electron-builder docs](https://www.electron.build)
- [Typescript docs](https://www.typescriptlang.org/docs)
- [Tslint docs](https://palantir.github.io/tslint/usage/configuration)
- [Stylelint docs](https://stylelint.io)
- [Prettier docs](https://prettier.io)
- [Husky](https://github.com/typicode/husky)
- [lint-staged](https://github.com/okonet/lint-staged)
- [Github CI](https://help.github.com/en/actions/building-and-testing-code-with-continuous-integration/about-continuous-integration)