Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radiium/elegular
Electron + Angular quick start template with hot reload
https://github.com/radiium/elegular
angular boilerplate desktop-app electron quickstart template typescript
Last synced: 2 days ago
JSON representation
Electron + Angular quick start template with hot reload
- Host: GitHub
- URL: https://github.com/radiium/elegular
- Owner: radiium
- License: mit
- Created: 2018-06-30T22:44:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T06:44:23.000Z (almost 2 years ago)
- Last Synced: 2024-05-29T19:01:55.319Z (6 months ago)
- Topics: angular, boilerplate, desktop-app, electron, quickstart, template, typescript
- Language: TypeScript
- Homepage:
- Size: 11.9 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Elegular
## Description:
A preconfigured Electron + Angular 10 starter kit boilerplate with hot reload and others...
#### built with:
- [angular 10](https://angular.io/)
- [electron 10](https://electron.atom.io/)
- [electron builder](https://github.com/electron-userland/electron-builder/)
- [electron-reload](https://github.com/yan-foto/electron-reload#readme)
- [electron-context-menu](https://github.com/sindresorhus/electron-context-menu)
- [ngx-electron](https://github.com/ThorstenHans/ngx-electron)
- [Reset CSS (By Eric meyer)](http://meyerweb.com/eric/tools/css/reset/)
#### Project structure:
```bash
/elegular
├── build # Electron assets files (desktop icons etc...)
├── dist # Build output folder
├── release # Release output folder (build executable)
├── e2e
├── src # Angular source code
├── src-electron # Electron source code
├── .editorconfig
├── .gitignore
├── angular.json
├── package-lock.json
├── LICENCE.md
├── package.json
├── README.md
├── electron-builder.yml # electron-builder configuration
├── tsconfig.json
└── tslint.json
```
## Getting Started:
#### Prerequisites:
For run this project, you need to install the following:
- [Nodejs](https://nodejs.org) >= 12.x.x
#### Clone repository and install dependencies:
```
git clone --depth 1 https://github.com/radiium/elegular
cd elegular
npm install
```
#### Available commands:
| Command | Description |
|---------|-------------|
| `npm run start` | Start app in dev mode with hot-reload |
| `npm run start:prod` | Start app in electron with prod mode |
| `npm run start:web` | Start app in browser at http://localhost:4200 (without electron) |
| `npm run release` | Build and release for the current target |
| `npm run release -- -linux` | Build and release for Linux target |
| `npm run release -- --mac` | Build and release for Mac target |
| `npm run release -- -win` | Build and release for Windows target|
| `npm run release:all` | Build and release for all platform target (linux/mac/windows) |
## License
[MIT](LICENCE.md)