├── src ├── assets │ ├── .gitkeep │ ├── icons │ │ ├── favicon.png │ │ ├── favicon.icns │ │ ├── favicon.256x256.png │ │ └── favicon.512x512.png │ ├── images │ │ └── angular.png │ └── fonts │ │ ├── Roboto-Black.ttf │ │ ├── Roboto-Bold.ttf │ │ ├── Roboto-Light.ttf │ │ ├── Roboto-Thin.ttf │ │ ├── Roboto-Italic.ttf │ │ ├── Roboto-Medium.ttf │ │ ├── Roboto-Regular.ttf │ │ ├── Roboto-BoldItalic.ttf │ │ ├── Roboto-ThinItalic.ttf │ │ ├── Roboto-BlackItalic.ttf │ │ ├── Roboto-LightItalic.ttf │ │ ├── Roboto-MediumItalic.ttf │ │ └── LICENSE.txt ├── app │ ├── scss │ │ ├── _index.scss │ │ ├── _colors.scss │ │ └── _fonts.scss │ ├── app.component.scss │ ├── data-access │ │ ├── entities │ │ │ └── user.entity.ts │ │ ├── database.service.ts │ │ └── repositories │ │ │ └── settings.ts │ ├── app.module.ts │ ├── app.component.ts │ └── app.component.html ├── environments │ ├── environment.prod.ts │ └── environment.ts ├── favicon.ico ├── tslint.json ├── tsconfig.app.json ├── main.ts ├── index.html ├── styles.scss └── polyfills.ts ├── .travis.yml ├── extra-webpack.config.js ├── postinstall.config.js ├── tsconfig.json ├── postinstall-web.js ├── postinstall.js ├── electron-builder.json ├── LICENSE ├── .gitignore ├── main.ts ├── package.json ├── tslint.json ├── README.md └── angular.json /src/assets/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/app/scss/_index.scss: -------------------------------------------------------------------------------- 1 | @import '_colors'; 2 | @import '_fonts'; -------------------------------------------------------------------------------- /src/environments/environment.prod.ts: -------------------------------------------------------------------------------- 1 | export const environment = { 2 | production: true 3 | }; 4 | -------------------------------------------------------------------------------- /src/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/favicon.ico -------------------------------------------------------------------------------- /src/assets/icons/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/icons/favicon.png -------------------------------------------------------------------------------- /src/assets/icons/favicon.icns: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/icons/favicon.icns -------------------------------------------------------------------------------- /src/assets/images/angular.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/images/angular.png -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - 10 4 | sudo: required 5 | install: 6 | - npm install 7 | script: 8 | - npm run build:prod 9 | -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Black.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Black.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Bold.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Light.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Thin.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Thin.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Italic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Italic.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Medium.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-Regular.ttf -------------------------------------------------------------------------------- /src/assets/icons/favicon.256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/icons/favicon.256x256.png -------------------------------------------------------------------------------- /src/assets/icons/favicon.512x512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/icons/favicon.512x512.png -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-BoldItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-BoldItalic.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-ThinItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-ThinItalic.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-BlackItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-BlackItalic.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-LightItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-LightItalic.ttf -------------------------------------------------------------------------------- /src/assets/fonts/Roboto-MediumItalic.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CubikNeRubik/angular-electron-typeorm-starter/HEAD/src/assets/fonts/Roboto-MediumItalic.ttf -------------------------------------------------------------------------------- /src/app/app.component.scss: -------------------------------------------------------------------------------- 1 | @import 'scss/index'; 2 | table { 3 | width: 100%; 4 | } 5 | 6 | .example-container { 7 | display: flex; 8 | flex-direction: column; 9 | } 10 | 11 | .example-container > * { 12 | width: 100%; 13 | } -------------------------------------------------------------------------------- /src/app/scss/_colors.scss: -------------------------------------------------------------------------------- 1 | $colors: ( 2 | color1: #FFFFFF, 3 | color2: #000000, 4 | color3: #38627b, 5 | color4: #132e45, 6 | color5: #132838, 7 | color6: #198e7f, 8 | color7: #162e41 9 | ); 10 | 11 | @function get-color($key) { 12 | @return map-get($colors, $key); 13 | } -------------------------------------------------------------------------------- /src/tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tslint.json", 3 | "rules": { 4 | "directive-selector": [ 5 | true, 6 | "attribute", 7 | "rp", 8 | "camelCase" 9 | ], 10 | "component-selector": [ 11 | true, 12 | "element", 13 | "rp", 14 | "kebab-case" 15 | ] 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /extra-webpack.config.js: -------------------------------------------------------------------------------- 1 | const path = require('path'); 2 | 3 | module.exports = { 4 | target: 'electron-renderer', 5 | externals: { 6 | typeorm: "require('typeorm')", 7 | sqlite3: "require('sqlite3')", 8 | }, 9 | resolve: { 10 | alias: { 11 | typeorm: path.resolve(__dirname, "../node_modules/typeorm/typeorm-model-shim") 12 | } 13 | } 14 | }; -------------------------------------------------------------------------------- /src/app/data-access/entities/user.entity.ts: -------------------------------------------------------------------------------- 1 | import { Entity, PrimaryGeneratedColumn, Column, BaseEntity } from "typeorm"; 2 | 3 | @Entity({name: 'user'}) 4 | export class User extends BaseEntity { 5 | 6 | @PrimaryGeneratedColumn() 7 | Id: number; 8 | 9 | @Column() 10 | FirstName: string; 11 | 12 | @Column() 13 | LastName: string; 14 | 15 | @Column() 16 | Age: number; 17 | } -------------------------------------------------------------------------------- /postinstall.config.js: -------------------------------------------------------------------------------- 1 | const config = require('./extra-webpack.config.js'); 2 | 3 | module.exports.getConfigs = function(){ 4 | config.target = 'electron-renderer'; 5 | electronConfig = JSON.stringify(config).slice(1,-1) + ','; 6 | 7 | config.target = 'web'; 8 | webConfig = JSON.stringify(config).slice(1,-1) + ','; 9 | 10 | return { 11 | electronConfig, 12 | webConfig 13 | }; 14 | }; 15 | -------------------------------------------------------------------------------- /src/tsconfig.app.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tsconfig.json", 3 | "compilerOptions": { 4 | "outDir": "../out-tsc/app", 5 | "module": "es2015", 6 | "types": [], 7 | "paths": { 8 | "typeorm": ["../node_modules/typeorm/typeorm-model-shim.js"] 9 | } 10 | }, 11 | "exclude": [ 12 | "src/test.ts", 13 | "**/*.spec.ts", 14 | "dist", 15 | "app-builds", 16 | "node_modules" 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /src/app/scss/_fonts.scss: -------------------------------------------------------------------------------- 1 | $weights: ( 2 | extra-bold: 900, 3 | bold: 700, 4 | semi-bold: 600, 5 | medium: 500, 6 | normal: 400, 7 | light: 300 8 | ); 9 | 10 | @mixin font($size, $color) { 11 | font-family: $primary-font, $secondary-font; 12 | font-weight: $normal; 13 | font-size: $size; 14 | color: $color; 15 | } 16 | 17 | @function get-weight($key) { 18 | @return map-get($weights, $key); 19 | } -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { enableProdMode } from '@angular/core'; 2 | import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; 3 | 4 | import { AppModule } from './app/app.module'; 5 | import { environment } from './environments/environment'; 6 | 7 | import 'hammerjs'; 8 | 9 | if (environment.production) { 10 | enableProdMode(); 11 | } 12 | 13 | platformBrowserDynamic().bootstrapModule(AppModule) 14 | .catch(err => console.log(err)); 15 | -------------------------------------------------------------------------------- /src/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | angular-electron-typeorm-starter 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compileOnSave": false, 3 | "buildOnSave": false, 4 | "compilerOptions": { 5 | "baseUrl": "./", 6 | "outDir": "./dist/out-tsc", 7 | "sourceMap": true, 8 | "declaration": false, 9 | "moduleResolution": "node", 10 | "emitDecoratorMetadata": true, 11 | "experimentalDecorators": true, 12 | "target": "es5", 13 | "typeRoots": [ 14 | "node_modules/@types" 15 | ], 16 | "lib": [ 17 | "es2017", 18 | "dom" 19 | ] 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/styles.scss: -------------------------------------------------------------------------------- 1 | @import '~@angular/material/prebuilt-themes/deeppurple-amber.css'; 2 | 3 | // @import '~@angular/material/prebuilt-themes/indigo-pink.css'; 4 | // @import '~@angular/material/prebuilt-themes/pink-bluegrey.css'; 5 | // @import '~@angular/material/prebuilt-themes/purple-green.css'; 6 | html, 7 | body { 8 | height: 100vh; 9 | font-family: "Roboto", "Segoe UI", "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; 10 | margin: 0; 11 | padding: 0; 12 | } -------------------------------------------------------------------------------- /src/environments/environment.ts: -------------------------------------------------------------------------------- 1 | // This file can be replaced during build by using the `fileReplacements` array. 2 | // `ng build ---prod` replaces `environment.ts` with `environment.prod.ts`. 3 | // The list of file replacements can be found in `angular.json`. 4 | 5 | export const environment = { 6 | production: false 7 | }; 8 | 9 | /* 10 | * In development mode, to ignore zone related error stack frames such as 11 | * `zone.run`, `zoneDelegate.invokeTask` for easier debugging, you can 12 | * import the following file, but please comment it out in production mode 13 | * because it will have performance impact when throw error 14 | */ 15 | // import 'zone.js/dist/zone-error'; // Included with Angular CLI. 16 | -------------------------------------------------------------------------------- /postinstall-web.js: -------------------------------------------------------------------------------- 1 | // This script change webpack-configs for "ng serve" 2 | const fs = require('fs'); 3 | const f_angular = 'node_modules/@angular-devkit/build-angular/src/angular-cli-files/models/webpack-configs/browser.js'; 4 | const { getConfigs } = require('./postinstall.config'); 5 | 6 | const { webConfig } = getConfigs(); 7 | fs.readFile(f_angular, 'utf8', function (err, data) { 8 | 9 | if (err) { 10 | return console.log(err); 11 | } 12 | 13 | let result = data.replace(/return {[\s\S]+?$/m, 'return {'); 14 | result = result.replace(/target: "web",/g, ''); 15 | result = result.replace(/return \{/g, 'return {' + webConfig); 16 | 17 | fs.writeFile(f_angular, result, 'utf8', function (err) { 18 | if (err) return console.log(err); 19 | }); 20 | }); 21 | -------------------------------------------------------------------------------- /postinstall.js: -------------------------------------------------------------------------------- 1 | // This script change webpack-configs for "ng serve" 2 | const fs = require('fs'); 3 | const f_angular = 'node_modules/@angular-devkit/build-angular/src/angular-cli-files/models/webpack-configs/browser.js'; 4 | const { getConfigs } = require('./postinstall.config'); 5 | 6 | const { electronConfig } = getConfigs(); 7 | fs.readFile(f_angular, 'utf8', function (err, data) { 8 | 9 | if (err) { 10 | return console.log(err); 11 | } 12 | 13 | let result = data.replace(/return {[\s\S]+?$/m, 'return {'); 14 | result = result.replace(/target: "web",/g, ''); 15 | result = result.replace(/return \{/g, 'return {' + electronConfig); 16 | 17 | fs.writeFile(f_angular, result, 'utf8', function (err) { 18 | if (err) return console.log(err); 19 | }); 20 | }); 21 | -------------------------------------------------------------------------------- /src/app/data-access/database.service.ts: -------------------------------------------------------------------------------- 1 | import {Injectable} from '@angular/core'; 2 | import {Connection, ConnectionOptions, createConnection} from 'typeorm'; 3 | import {Settings} from './repositories/settings'; 4 | import {User} from './entities/user.entity'; 5 | 6 | @Injectable({ 7 | providedIn: 'root' 8 | }) 9 | export class DatabaseService { 10 | 11 | public connection: Promise; 12 | private readonly options: ConnectionOptions; 13 | 14 | constructor() { 15 | Settings.initialize(); 16 | this.options = { 17 | type: 'sqlite', 18 | database: Settings.dbPath, 19 | entities: [User], 20 | synchronize: true, 21 | logging: 'all', 22 | }; 23 | this.connection = createConnection(this.options); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /electron-builder.json: -------------------------------------------------------------------------------- 1 | { 2 | "productName": "app-ui", 3 | "directories": { 4 | "output": "app-builds" 5 | }, 6 | "files": [ 7 | "**/*", 8 | "!*.ts", 9 | "!*.code-workspace", 10 | "!LICENSE.md", 11 | "!package.json", 12 | "!package-lock.json", 13 | "!src/", 14 | "!e2e/", 15 | "!hooks/", 16 | "!.angular-cli.json", 17 | "!_config.yml", 18 | "!karma.conf.js", 19 | "!tsconfig.json", 20 | "!tslint.json" 21 | ], 22 | "win": { 23 | "icon": "dist/assets/icons", 24 | "target": [ 25 | "portable" 26 | ] 27 | }, 28 | "mac": { 29 | "icon": "dist", 30 | "target": [ 31 | "dmg" 32 | ] 33 | }, 34 | "linux": { 35 | "icon": "dist", 36 | "target": [ 37 | "AppImage" 38 | ] 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/app/data-access/repositories/settings.ts: -------------------------------------------------------------------------------- 1 | import * as path from 'path'; 2 | import { remote } from 'electron'; 3 | import { environment } from '../../../environments/environment'; 4 | 5 | export class Settings { 6 | 7 | public static dbFolder: string; 8 | public static dbPath: string; 9 | public static appPath: string; 10 | private static dataSubFolder: string; 11 | private static dbName = 'database.db'; 12 | 13 | public static initialize(): void { 14 | Settings.getPaths(); 15 | } 16 | 17 | private static getPaths() { 18 | 19 | if(environment.production){ 20 | this.dataSubFolder = '/'; 21 | Settings.appPath = remote.app.getPath('userData'); 22 | } else { 23 | // return folder where app is running 24 | this.dataSubFolder = 'dist/assets/data'; 25 | Settings.appPath = remote.app.getAppPath(); 26 | } 27 | 28 | Settings.dbFolder = path.join(Settings.appPath, Settings.dataSubFolder); 29 | Settings.dbPath = path.join(Settings.dbFolder, this.dbName) 30 | } 31 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 SkySoft-Tech 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /src/app/app.module.ts: -------------------------------------------------------------------------------- 1 | import {BrowserModule} from '@angular/platform-browser'; 2 | import {FormsModule} from '@angular/forms'; 3 | import {BrowserAnimationsModule} from '@angular/platform-browser/animations'; 4 | import { MatButtonModule } from '@angular/material/button'; 5 | import { MatCardModule } from '@angular/material/card'; 6 | import { MatFormFieldModule } from '@angular/material/form-field'; 7 | import { MatGridListModule } from '@angular/material/grid-list'; 8 | import { MatInputModule } from '@angular/material/input'; 9 | import { MatTableModule } from '@angular/material/table'; 10 | import {NgModule} from '@angular/core'; 11 | 12 | import {AppComponent} from './app.component'; 13 | 14 | @NgModule({ 15 | declarations: [ 16 | AppComponent 17 | ], 18 | imports: [ 19 | BrowserModule, 20 | BrowserAnimationsModule, 21 | FormsModule, 22 | MatTableModule, 23 | MatCardModule, 24 | MatFormFieldModule, 25 | MatInputModule, 26 | MatGridListModule, 27 | MatButtonModule 28 | ], 29 | providers: [], 30 | bootstrap: [AppComponent] 31 | }) 32 | export class AppModule { 33 | } 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | .vscode/* 64 | .vscode/settings.json 65 | .vscode/tasks.json 66 | .vscode/launch.json 67 | .vscode/extensions.json 68 | .idea/* 69 | 70 | # compiled output 71 | dist 72 | tmp 73 | out-tsc 74 | app-builds/ 75 | main.js 76 | .editorconfig 77 | -------------------------------------------------------------------------------- /src/app/app.component.ts: -------------------------------------------------------------------------------- 1 | import {Component} from '@angular/core'; 2 | import {DatabaseService} from "./data-access/database.service"; 3 | import {User} from "./data-access/entities/user.entity"; 4 | 5 | @Component({ 6 | selector: 'app-root', 7 | templateUrl: './app.component.html', 8 | styleUrls: ['./app.component.scss'] 9 | }) 10 | export class AppComponent { 11 | 12 | users: User[] = []; 13 | displayedColumns: string[] = ['Id', 'FirstName', 'LastName', 'Age']; 14 | 15 | firstName: string = ''; 16 | lastName: string = ''; 17 | age: string = ''; 18 | 19 | constructor(private databaseService: DatabaseService) { 20 | this.getUsers(); 21 | } 22 | 23 | getUsers(){ 24 | this.databaseService 25 | .connection 26 | .then(() => User.find()) 27 | .then(users => { 28 | this.users = users; 29 | }) 30 | } 31 | 32 | addUser(){ 33 | const user = new User(); 34 | 35 | user.FirstName = this.firstName; 36 | user.LastName = this.lastName; 37 | user.Age = +this.age; 38 | 39 | this.databaseService 40 | .connection 41 | .then(() => user.save()) 42 | .then(() => { 43 | this.getUsers(); 44 | }) 45 | .then(() => { 46 | this.firstName = ''; 47 | this.lastName = ''; 48 | this.age = ''; 49 | }) 50 | } 51 | 52 | } 53 | -------------------------------------------------------------------------------- /src/app/app.component.html: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 |
17 | 18 | 19 | 20 | 21 | 22 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 |
Id {{element.Id}} First Name {{element.FirstName}} Last Name {{element.LastName}} Age {{element.Age}}
52 | 53 | -------------------------------------------------------------------------------- /main.ts: -------------------------------------------------------------------------------- 1 | import {app, BrowserWindow, Menu, Tray} from 'electron'; 2 | import * as path from 'path'; 3 | import * as url from 'url'; 4 | 5 | let win: BrowserWindow = null; 6 | 7 | // detect serve mode 8 | const args = process.argv.slice(1); 9 | let serve: boolean = args.some(val => val === '--serve'); 10 | 11 | function createWindow() { 12 | 13 | win = new BrowserWindow({ 14 | width: 800, 15 | height: 600, 16 | webPreferences: { 17 | nodeIntegration: true 18 | }, 19 | }); 20 | 21 | 22 | if (serve) { 23 | // get dynamic version from localhost:4200 24 | require('electron-reload')(__dirname, { 25 | electron: require(`${__dirname}/node_modules/electron`) 26 | }); 27 | win.loadURL('http://localhost:4200'); 28 | 29 | // The following is optional and will open the DevTools: 30 | win.webContents.openDevTools(); 31 | } else { 32 | // load the dist folder from Angular 33 | win.loadURL( 34 | url.format({ 35 | pathname: path.join(__dirname, `/dist/index.html`), 36 | protocol: "file:", 37 | slashes: true, 38 | //icon: path.join(__dirname, 'assets/icons/favicon.png') 39 | }) 40 | ); 41 | } 42 | 43 | win.on('closed', () => { 44 | win = null; 45 | }); 46 | } 47 | 48 | try { 49 | 50 | // This method will be called when Electron has finished 51 | // initialization and is ready to create browser windows. 52 | // Some APIs can only be used after this event occurs. 53 | app.on('ready', createWindow); 54 | 55 | // Quit when all windows are closed. 56 | app.on('window-all-closed', () => { 57 | // On OS X it is common for applications and their menu bar 58 | // to stay active until the user quits explicitly with Cmd + Q 59 | if (process.platform !== 'darwin') { 60 | app.quit(); 61 | } 62 | }); 63 | 64 | // initialize the app's main window 65 | app.on("activate", () => { 66 | if (win === null) { 67 | createWindow(); 68 | } 69 | }); 70 | 71 | } catch (e) { 72 | // Catch Error 73 | // throw e; 74 | } 75 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "angular-electron-typeorm-starter", 3 | "version": "0.0.0", 4 | "main": "main.js", 5 | "description": "Angular 6(+) and Electron (Typescript + SCSS + Hot Reload) for creating cross platform applications.", 6 | "homepage": "https://github.com/CubikNeRubik/angular-electron-typeorm-starter", 7 | "author": { 8 | "name": "Vlad Haidei", 9 | "email": "vlad.gaidei@gmail.com" 10 | }, 11 | "keywords": [ 12 | "angular", 13 | "angular 6", 14 | "electron", 15 | "typescript", 16 | "typeorm", 17 | "sass", 18 | "scss" 19 | ], 20 | "scripts": { 21 | "build": "npm run postinstall:electron && npm run electron:tsc && ng build", 22 | "build:dev": "npm run build -- -c dev", 23 | "build:prod": "npm run build -- -c production", 24 | "electron:tsc": "tsc main.ts", 25 | "electron:serve": "wait-on http-get://localhost:4200/ && npm run electron:tsc && electron ./ --serve", 26 | "electron:local": "npm run build:prod && electron .", 27 | "electron:linux": "npm run build:prod && npx electron-builder build --linux", 28 | "electron:windows": "npm run build:prod && npx electron-builder build --windows", 29 | "electron:mac": "npm run build:prod && npx electron-builder build --mac", 30 | "start": "npm run postinstall:electron && npm-run-all -p ng:serve electron:serve", 31 | "ng:serve": "ng serve", 32 | "ng:serve:web": "npm run postinstall:web && npm run electron:tsc && ng serve -o", 33 | "postinstall": "npm run postinstall:electron && npx electron-builder install-app-deps", 34 | "postinstall:web": "node postinstall-web", 35 | "postinstall:electron": "node postinstall" 36 | }, 37 | "private": true, 38 | "dependencies": { 39 | "sqlite3": "^4.0.9", 40 | "typeorm": "^0.2.18" 41 | }, 42 | "devDependencies": { 43 | "@angular-builders/custom-webpack": "^8.0.2", 44 | "@angular-devkit/architect": "^0.800.3", 45 | "@angular-devkit/build-angular": "^0.800.3", 46 | "@angular-devkit/core": "^8.0.3", 47 | "@angular/animations": "^8.0.1", 48 | "@angular/cdk": "^8.0.1", 49 | "@angular/cli": "~8.0.3", 50 | "@angular/common": "^8.0.1", 51 | "@angular/compiler": "^8.0.1", 52 | "@angular/compiler-cli": "^8.0.1", 53 | "@angular/core": "^8.0.1", 54 | "@angular/forms": "^8.0.1", 55 | "@angular/http": "^7.0.0", 56 | "@angular/language-service": "^8.0.1", 57 | "@angular/material": "^8.0.1", 58 | "@angular/platform-browser": "^8.0.1", 59 | "@angular/platform-browser-dynamic": "^8.0.1", 60 | "@angular/router": "^8.0.1", 61 | "@types/node": "~12.0.8", 62 | "angular-cli-builders": "^2.1.2", 63 | "codelyzer": "~5.1.0", 64 | "commonjs": "0.0.1", 65 | "copy-webpack-plugin": "^5.0.3", 66 | "core-js": "^3.1.4", 67 | "electron": "^9.4.0", 68 | "electron-builder": "^20.44.2", 69 | "electron-reload": "^1.4.0", 70 | "fs": "0.0.1-security", 71 | "hammerjs": "^2.0.8", 72 | "npm-run-all": "4.1.5", 73 | "npx": "^10.2.0", 74 | "rxjs": "^6.5.2", 75 | "stream": "0.0.2", 76 | "ts-node": "~8.3.0", 77 | "tslint": "~5.17.0", 78 | "typescript": "^3.4.5", 79 | "wait-on": "3.2.0", 80 | "webpack": "^4.34.0", 81 | "zone.js": "^0.9.1" 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "rulesDirectory": [ 3 | "node_modules/codelyzer" 4 | ], 5 | "rules": { 6 | "arrow-return-shorthand": true, 7 | "callable-types": true, 8 | "class-name": true, 9 | "comment-format": [ 10 | true, 11 | "check-space" 12 | ], 13 | "curly": true, 14 | "deprecation": { 15 | "severity": "warn" 16 | }, 17 | "eofline": true, 18 | "forin": true, 19 | "import-blacklist": [ 20 | true, 21 | "rxjs/Rx" 22 | ], 23 | "import-spacing": true, 24 | "indent": [ 25 | true, 26 | "spaces" 27 | ], 28 | "interface-over-type-literal": true, 29 | "label-position": true, 30 | "max-line-length": [ 31 | true, 32 | 140 33 | ], 34 | "member-access": false, 35 | "member-ordering": [ 36 | true, 37 | { 38 | "order": [ 39 | "static-field", 40 | "instance-field", 41 | "static-method", 42 | "instance-method" 43 | ] 44 | } 45 | ], 46 | "no-arg": true, 47 | "no-bitwise": true, 48 | "no-console": [ 49 | true, 50 | "debug", 51 | "info", 52 | "time", 53 | "timeEnd", 54 | "trace" 55 | ], 56 | "no-construct": true, 57 | "no-debugger": true, 58 | "no-duplicate-super": true, 59 | "no-empty": false, 60 | "no-empty-interface": true, 61 | "no-eval": true, 62 | "no-inferrable-types": [ 63 | true, 64 | "ignore-params" 65 | ], 66 | "no-misused-new": true, 67 | "no-non-null-assertion": true, 68 | "no-shadowed-variable": true, 69 | "no-string-literal": false, 70 | "no-string-throw": true, 71 | "no-switch-case-fall-through": true, 72 | "no-trailing-whitespace": true, 73 | "no-unnecessary-initializer": true, 74 | "no-unused-expression": true, 75 | "no-use-before-declare": true, 76 | "no-var-keyword": true, 77 | "object-literal-sort-keys": false, 78 | "one-line": [ 79 | true, 80 | "check-open-brace", 81 | "check-catch", 82 | "check-else", 83 | "check-whitespace" 84 | ], 85 | "prefer-const": true, 86 | "quotemark": [ 87 | true, 88 | "single" 89 | ], 90 | "radix": true, 91 | "semicolon": [ 92 | true, 93 | "always" 94 | ], 95 | "triple-equals": [ 96 | true, 97 | "allow-null-check" 98 | ], 99 | "typedef-whitespace": [ 100 | true, 101 | { 102 | "call-signature": "nospace", 103 | "index-signature": "nospace", 104 | "parameter": "nospace", 105 | "property-declaration": "nospace", 106 | "variable-declaration": "nospace" 107 | } 108 | ], 109 | "unified-signatures": true, 110 | "variable-name": false, 111 | "whitespace": [ 112 | true, 113 | "check-branch", 114 | "check-decl", 115 | "check-operator", 116 | "check-separator", 117 | "check-type" 118 | ], 119 | "no-output-on-prefix": true, 120 | "use-input-property-decorator": true, 121 | "use-output-property-decorator": true, 122 | "use-host-property-decorator": true, 123 | "no-input-rename": true, 124 | "no-output-rename": true, 125 | "use-life-cycle-interface": true, 126 | "use-pipe-transform-interface": true, 127 | "component-class-suffix": true, 128 | "directive-class-suffix": true 129 | } 130 | } -------------------------------------------------------------------------------- /src/polyfills.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * This file includes polyfills needed by Angular and is loaded before the app. 3 | * You can add your own extra polyfills to this file. 4 | * 5 | * This file is divided into 2 sections: 6 | * 1. Browser polyfills. These are applied before loading ZoneJS and are sorted by browsers. 7 | * 2. Application imports. Files imported after ZoneJS that should be loaded before your main 8 | * file. 9 | * 10 | * The current setup is for so-called "evergreen" browsers; the last versions of browsers that 11 | * automatically update themselves. This includes Safari >= 10, Chrome >= 55 (including Opera), 12 | * Edge >= 13 on the desktop, and iOS 10 and Chrome on mobile. 13 | * 14 | * Learn more in https://angular.io/docs/ts/latest/guide/browser-support.html 15 | */ 16 | 17 | /*************************************************************************************************** 18 | * BROWSER POLYFILLS 19 | */ 20 | 21 | /** IE9, IE10 and IE11 requires all of the following polyfills. **/ 22 | // import 'core-js/es6/symbol'; 23 | // import 'core-js/es6/object'; 24 | // import 'core-js/es6/function'; 25 | // import 'core-js/es6/parse-int'; 26 | // import 'core-js/es6/parse-float'; 27 | // import 'core-js/es6/number'; 28 | // import 'core-js/es6/math'; 29 | // import 'core-js/es6/string'; 30 | // import 'core-js/es6/date'; 31 | // import 'core-js/es6/array'; 32 | // import 'core-js/es6/regexp'; 33 | // import 'core-js/es6/map'; 34 | // import 'core-js/es6/weak-map'; 35 | // import 'core-js/es6/set'; 36 | 37 | /** IE10 and IE11 requires the following for NgClass support on SVG elements */ 38 | // import 'classlist.js'; // Run `npm install --save classlist.js`. 39 | 40 | /** IE10 and IE11 requires the following for the Reflect API. */ 41 | // import 'core-js/es6/reflect'; 42 | 43 | 44 | /** Evergreen browsers require these. **/ 45 | // Used for reflect-metadata in JIT. If you use AOT (and only Angular decorators), you can remove. 46 | // import 'core-js/es7/reflect'; 47 | 48 | 49 | /** 50 | * Web Animations `@angular/platform-browser/animations` 51 | * Only required if AnimationBuilder is used within the application and using IE/Edge or Safari. 52 | * Standard animation support in Angular DOES NOT require any polyfills (as of Angular 6.0). 53 | **/ 54 | // import 'web-animations-js'; // Run `npm install --save web-animations-js`. 55 | 56 | /** 57 | * By default, zone.js will patch all possible macroTask and DomEvents 58 | * user can disable parts of macroTask/DomEvents patch by setting following flags 59 | */ 60 | 61 | // (window as any).__Zone_disable_requestAnimationFrame = true; // disable patch requestAnimationFrame 62 | // (window as any).__Zone_disable_on_property = true; // disable patch onProperty such as onclick 63 | // (window as any).__zone_symbol__BLACK_LISTED_EVENTS = ['scroll', 'mousemove']; // disable patch specified eventNames 64 | 65 | /* 66 | * in IE/Edge developer tools, the addEventListener will also be wrapped by zone.js 67 | * with the following flag, it will bypass `zone.js` patch for IE/Edge 68 | */ 69 | // (window as any).__Zone_enable_cross_context_check = true; 70 | 71 | /*************************************************************************************************** 72 | * Zone JS is required by default for Angular itself. 73 | */ 74 | import 'zone.js/dist/zone'; // Included with Angular CLI. 75 | 76 | 77 | 78 | /*************************************************************************************************** 79 | * APPLICATION IMPORTS 80 | */ 81 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 |
10 | 11 | [![Electron Logo](https://electronjs.org/images/electron-logo.svg)](https://electronjs.org) 12 | 13 | 14 | [![Build Status](https://travis-ci.org/CubikNeRubik/angular-electron-typeorm-starter.svg?branch=master)](https://travis-ci.org/CubikNeRubik/angular-electron-typeorm-starter) 15 | [![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE.md) 16 | 17 | [![Watch on GitHub][github-watch-badge]][github-watch] 18 | [![Star on GitHub][github-star-badge]][github-star] 19 | 20 | # Quickstart 21 | ``` bash 22 | git clone https://github.com/CubikNeRubik/angular-electron-typeorm-starter.git 23 | npm install 24 | npm start 25 | ``` 26 | 27 | # Introduction 28 | 29 | This is a start kit for easy launch of Electron, Angular 6 and TypeORM. 30 | 31 | Currently runs with: 32 | 33 | - Angular v8.0.3 34 | - Electron v5.0.4 35 | - Electron Builder v20.44.1 36 | - Angular Material v8.0.1 37 | - TypeORM v0.2.18 38 | - SQLite v4.0.9 39 | 40 | With this start kit, you can : 41 | 42 | - Run your app in a local development environment with Electron & Hot reload 43 | - Run your app in a production environment 44 | - Package your app into an executable file for Linux, Windows & Mac 45 | 46 | ## Getting Started 47 | 48 | Clone this repository locally : 49 | 50 | ``` bash 51 | git clone https://github.com/CubikNeRubik/angular-electron-typeorm-starter.git 52 | ``` 53 | 54 | Install dependencies with npm : 55 | 56 | ``` bash 57 | npm install 58 | ``` 59 | 60 | If you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context. 61 | Please follow [Angular-cli documentation](https://github.com/angular/angular-cli) if you had installed a previous version of `angular-cli`. 62 | 63 | ``` bash 64 | npm install -g @angular/cli 65 | ``` 66 | 67 | ## To build for development 68 | 69 | - **in a terminal window** -> npm start 70 | 71 | The application code is managed by `main.ts`. In this sample, the app runs with a simple Angular App (http://localhost:4200) and an Electron window whitch can edit data in database. 72 | The Angular component contains an example of Electron, TypeORM and NodeJS native lib import. 73 | If you need to add additional dependencies you shoud put it to `extra-webpack.config.js`. 74 | You can desactivate "Developer Tools" by commenting `win.webContents.openDevTools();` in `main.ts`. 75 | 76 | ## Included Commands 77 | 78 | |Command|Description| 79 | |--|--| 80 | |`npm run build`| Build the app. Your built files are in the /dist folder. | 81 | |`npm run build:prod`| Build the app with Angular aot. Your built files are in the /dist folder. | 82 | |`npm run electron:local`| Builds your application and start electron 83 | |`npm run electron:linux`| Builds your application and creates an app consumable on linux system | 84 | |`npm run electron:windows`| On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems | 85 | |`npm run electron:mac`| On a MAC OS, builds your application and generates a `.app` file of your application that can be run on Mac | 86 | 87 | **Your application is optimised. Only /dist folder and node dependencies are included in the executable.** 88 | 89 | ## Known issues 90 | 91 | 1. **Browser mode.** You can't use TypeORM in browser so it is not possible.If you need to run app in browser and don't need TypeORM you can use [angular-electron](https://github.com/maximegris/angular-electron) for that. 92 | 1. **Windows Build.** You cannot make build for `windows` if path to project folder contains spaces or not latin letters. 93 | 94 | [github-watch-badge]: https://img.shields.io/github/watchers/CubikNeRubik/angular-electron-typeorm-starter.svg?style=social 95 | [github-watch]: https://github.com/CubikNeRubik/angular-electron-typeorm-starter/watchers 96 | [github-star-badge]: https://img.shields.io/github/stars/CubikNeRubik/angular-electron-typeorm-starter.svg?style=social 97 | [github-star]: https://github.com/CubikNeRubik/angular-electron-typeorm-starter/stargazers 98 | -------------------------------------------------------------------------------- /angular.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "./node_modules/@angular/cli/lib/config/schema.json", 3 | "version": 1, 4 | "newProjectRoot": "projects", 5 | "projects": { 6 | "app-ui": { 7 | "root": "", 8 | "sourceRoot": "src", 9 | "projectType": "application", 10 | "prefix": "app", 11 | "schematics": { 12 | "@schematics/angular:component": { 13 | "styleext": "scss" 14 | } 15 | }, 16 | "architect": { 17 | "build": { 18 | "builder": "@angular-builders/custom-webpack:browser", 19 | "options": { 20 | "customWebpackConfig": { 21 | "path": "./extra-webpack.config.js" 22 | }, 23 | "outputPath": "dist", 24 | "index": "src/index.html", 25 | "main": "src/main.ts", 26 | "polyfills": "src/polyfills.ts", 27 | "tsConfig": "src/tsconfig.app.json", 28 | "assets": [ 29 | "src/favicon.ico", 30 | "src/assets" 31 | ], 32 | "styles": [ 33 | "src/styles.scss" 34 | ], 35 | "scripts": [] 36 | }, 37 | "configurations": { 38 | "dev": { 39 | "optimization": false, 40 | "outputHashing": "all", 41 | "sourceMap": true, 42 | "extractCss": true, 43 | "namedChunks": false, 44 | "aot": false, 45 | "extractLicenses": true, 46 | "vendorChunk": false, 47 | "buildOptimizer": false 48 | }, 49 | "production": { 50 | "optimization": true, 51 | "outputHashing": "all", 52 | "sourceMap": false, 53 | "extractCss": true, 54 | "namedChunks": false, 55 | "aot": true, 56 | "extractLicenses": true, 57 | "vendorChunk": false, 58 | "buildOptimizer": true, 59 | "fileReplacements": [ 60 | { 61 | "replace": "src/environments/environment.ts", 62 | "with": "src/environments/environment.prod.ts" 63 | } 64 | ] 65 | } 66 | } 67 | }, 68 | "serve": { 69 | "builder": "@angular-devkit/build-angular:dev-server", 70 | "options": { 71 | "browserTarget": "app-ui:build" 72 | }, 73 | "configurations": { 74 | "dev": { 75 | "browserTarget": "app-ui:build:dev" 76 | }, 77 | "production": { 78 | "browserTarget": "app-ui:build:production" 79 | } 80 | } 81 | }, 82 | "extract-i18n": { 83 | "builder": "@angular-devkit/build-angular:extract-i18n", 84 | "options": { 85 | "browserTarget": "app-ui:build" 86 | } 87 | }, 88 | "test": { 89 | "builder": "@angular-devkit/build-angular:karma", 90 | "options": { 91 | "main": "src/test.ts", 92 | "polyfills": "src/polyfills.ts", 93 | "tsConfig": "src/tsconfig.spec.json", 94 | "karmaConfig": "src/karma.conf.js", 95 | "styles": [ 96 | "src/styles.scss" 97 | ], 98 | "scripts": [], 99 | "assets": [ 100 | "src/favicon.ico", 101 | "src/assets" 102 | ] 103 | } 104 | }, 105 | "lint": { 106 | "builder": "@angular-devkit/build-angular:tslint", 107 | "options": { 108 | "tsConfig": [ 109 | "src/tsconfig.app.json", 110 | "src/tsconfig.spec.json" 111 | ], 112 | "exclude": [ 113 | "**/node_modules/**" 114 | ] 115 | } 116 | } 117 | } 118 | }, 119 | "app-ui-e2e": { 120 | "root": "e2e/", 121 | "projectType": "application", 122 | "architect": { 123 | "e2e": { 124 | "builder": "@angular-devkit/build-angular:protractor", 125 | "options": { 126 | "protractorConfig": "e2e/protractor.conf.js", 127 | "devServerTarget": "app-ui:serve" 128 | } 129 | }, 130 | "lint": { 131 | "builder": "@angular-devkit/build-angular:tslint", 132 | "options": { 133 | "tsConfig": "e2e/tsconfig.e2e.json", 134 | "exclude": [ 135 | "**/node_modules/**" 136 | ] 137 | } 138 | } 139 | } 140 | } 141 | }, 142 | "defaultProject": "app-ui", 143 | "schematics": { 144 | "@schematics/angular:component": { 145 | "prefix": "app", 146 | "styleext": "scss" 147 | }, 148 | "@schematics/angular:directive": { 149 | "prefix": "app" 150 | } 151 | } 152 | } -------------------------------------------------------------------------------- /src/assets/fonts/LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------