Skip to content

Commit e033869

Browse files
abdalladarwishabdalladarwish
committed
add client-app
1 parent 68bd2b4 commit e033869

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+23263
-0
lines changed

‎chat-client/CHANGELOG.md

+703
Large diffs are not rendered by default.

‎chat-client/LICENSE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2020 - Maxime GRIS
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎chat-client/README.md

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
[![Angular Logo](https://www.vectorlogo.zone/logos/angular/angular-icon.svg)](https://angular.io/) [![Electron Logo](https://www.vectorlogo.zone/logos/electronjs/electronjs-icon.svg)](https://electronjs.org/)
2+
3+
![Maintained][maintained-badge]
4+
[![Travis Build Status][build-badge]][build]
5+
[![Make a pull request][prs-badge]][prs]
6+
[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE.md)
7+
8+
[![Watch on GitHub][github-watch-badge]][github-watch]
9+
[![Star on GitHub][github-star-badge]][github-star]
10+
[![Tweet][twitter-badge]][twitter]
11+
12+
# Introduction
13+
14+
Bootstrap and package your project with Angular 11 and Electron 11 (Typescript + SASS + Hot Reload) for creating Desktop applications.
15+
16+
Currently runs with:
17+
18+
- Angular v11.0.3
19+
- Electron v11.0.3
20+
- Electron Builder v22.9.1
21+
22+
With this sample, you can :
23+
24+
- Run your app in a local development environment with Electron & Hot reload
25+
- Run your app in a production environment
26+
- Package your app into an executable file for Linux, Windows & Mac
27+
28+
/!\ Hot reload only pertains to the renderer process. The main electron process is not able to be hot reloaded, only restarted.
29+
30+
/!\ Angular 11.x CLI needs Node 10.13 or later to work correctly.
31+
32+
## Getting Started
33+
34+
Clone this repository locally :
35+
36+
``` bash
37+
git clone https://github.com/maximegris/angular-electron.git
38+
```
39+
40+
Install dependencies with npm :
41+
42+
``` bash
43+
npm install
44+
```
45+
46+
There is an issue with `yarn` and `node_modules` when the application is built by the packager. Please use `npm` as dependencies manager.
47+
48+
49+
If you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context.
50+
Please follow [Angular-cli documentation](https://github.com/angular/angular-cli) if you had installed a previous version of `angular-cli`.
51+
52+
``` bash
53+
npm install -g @angular/cli
54+
```
55+
56+
## To build for development
57+
58+
- **in a terminal window** -> npm start
59+
60+
Voila! You can use your Angular + Electron app in a local development environment with hot reload !
61+
62+
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.
63+
The Angular component contains an example of Electron and NodeJS native lib import.
64+
You can disable "Developer Tools" by commenting `win.webContents.openDevTools();` in `main.ts`.
65+
66+
## Use Electron / NodeJS / 3rd party libraries
67+
68+
As see in previous chapter, this sample project runs on both mode (web and electron). To make this happens, **you have to import your dependencies the right way**. Please check `providers/electron.service.ts` to watch how conditional import of libraries has to be done when using electron / NodeJS / 3rd party librairies in renderer context (ie. Angular).
69+
70+
## Browser mode
71+
72+
Maybe you only want to execute the application in the browser with hot reload ? Just run `npm run ng:serve:web`.
73+
74+
## Included Commands
75+
76+
|Command|Description|
77+
|--|--|
78+
|`npm run ng:serve`| Execute the app in the browser |
79+
|`npm run build`| Build the app. Your built files are in the /dist folder. |
80+
|`npm run build:prod`| Build the app with Angular aot. Your built files are in the /dist folder. |
81+
|`npm run electron:local`| Builds your application and start electron
82+
|`npm run electron:build`| Builds your application and creates an app consumable based on your operating system |
83+
84+
**Your application is optimised. Only /dist folder and node dependencies are included in the executable.**
85+
86+
## You want to use a specific lib (like rxjs) in electron main thread ?
87+
88+
YES! You can do it! Just by importing your library in npm dependencies section (not **devDependencies**) with `npm install --save`. It will be loaded by electron during build phase and added to your final package. Then use your library by importing it in `main.ts` file. Quite simple, isn't it ?
89+
90+
## E2E Testing
91+
92+
E2E Test scripts can be found in `e2e` folder.
93+
94+
|Command|Description|
95+
|--|--|
96+
|`npm run e2e`| Execute end to end tests |
97+
98+
Note: To make it work behind a proxy, you can add this proxy exception in your terminal
99+
`export {no_proxy,NO_PROXY}="127.0.0.1,localhost"`
100+
101+
## Branch & Packages version
102+
103+
- Angular 4 & Electron 1 : Branch [angular4](https://github.com/maximegris/angular-electron/tree/angular4)
104+
- Angular 5 & Electron 1 : Branch [angular5](https://github.com/maximegris/angular-electron/tree/angular5)
105+
- Angular 6 & Electron 3 : Branch [angular6](https://github.com/maximegris/angular-electron/tree/angular6)
106+
- Angular 7 & Electron 3 : Branch [angular7](https://github.com/maximegris/angular-electron/tree/angular7)
107+
- Angular 8 & Electron 7 : Branch [angular8](https://github.com/maximegris/angular-electron/tree/angular8)
108+
- Angular 9 & Electron 7 : Branch [angular9](https://github.com/maximegris/angular-electron/tree/angular9)
109+
- Angular 10 & Electron 9 : Branch [angular10](https://github.com/maximegris/angular-electron/tree/angular9)
110+
- Angular 11 & Electron 10 : (master)
111+
112+
[build-badge]: https://travis-ci.org/maximegris/angular-electron.svg?branch=master&style=style=flat-square
113+
[build]: https://travis-ci.org/maximegris/angular-electron
114+
[license-badge]: https://img.shields.io/badge/license-Apache2-blue.svg?style=style=flat-square
115+
[license]: https://github.com/maximegris/angular-electron/blob/master/LICENSE.md
116+
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
117+
[prs]: http://makeapullrequest.com
118+
[github-watch-badge]: https://img.shields.io/github/watchers/maximegris/angular-electron.svg?style=social
119+
[github-watch]: https://github.com/maximegris/angular-electron/watchers
120+
[github-star-badge]: https://img.shields.io/github/stars/maximegris/angular-electron.svg?style=social
121+
[github-star]: https://github.com/maximegris/angular-electron/stargazers
122+
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20angular-electron!%20https://github.com/maximegris/angular-electron%20%F0%9F%91%8D
123+
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/maximegris/angular-electron.svg?style=social
124+
[maintained-badge]: https://img.shields.io/badge/maintained-yes-brightgreen

‎chat-client/_config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-architect

‎chat-client/angular.json

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
{
2+
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
3+
"version": 1,
4+
"newProjectRoot": "projects",
5+
"projects": {
6+
"angular-electron": {
7+
"root": "",
8+
"sourceRoot": "src",
9+
"projectType": "application",
10+
"architect": {
11+
"build": {
12+
"builder": "@angular-builders/custom-webpack:browser",
13+
"options": {
14+
"outputPath": "dist",
15+
"index": "src/index.html",
16+
"main": "src/main.ts",
17+
"tsConfig": "src/tsconfig.app.json",
18+
"polyfills": "src/polyfills.ts",
19+
"assets": [
20+
"src/assets"
21+
],
22+
"styles": [
23+
"./node_modules/@angular/material/prebuilt-themes/indigo-pink.css",
24+
"src/styles.scss"
25+
],
26+
"scripts": [],
27+
"customWebpackConfig": {
28+
"path": "./angular.webpack.js"
29+
}
30+
},
31+
"configurations": {
32+
"dev": {
33+
"optimization": false,
34+
"outputHashing": "all",
35+
"sourceMap": true,
36+
"namedChunks": false,
37+
"aot": false,
38+
"extractLicenses": true,
39+
"vendorChunk": false,
40+
"buildOptimizer": false,
41+
"fileReplacements": [
42+
{
43+
"replace": "src/environments/environment.ts",
44+
"with": "src/environments/environment.dev.ts"
45+
}
46+
]
47+
},
48+
"web": {
49+
"optimization": false,
50+
"outputHashing": "all",
51+
"sourceMap": true,
52+
"extractCss": true,
53+
"namedChunks": false,
54+
"aot": false,
55+
"extractLicenses": true,
56+
"vendorChunk": false,
57+
"buildOptimizer": false,
58+
"fileReplacements": [
59+
{
60+
"replace": "src/environments/environment.ts",
61+
"with": "src/environments/environment.web.ts"
62+
}
63+
]
64+
},
65+
"production": {
66+
"optimization": true,
67+
"outputHashing": "all",
68+
"sourceMap": false,
69+
"namedChunks": false,
70+
"aot": true,
71+
"extractLicenses": true,
72+
"vendorChunk": false,
73+
"buildOptimizer": true,
74+
"fileReplacements": [
75+
{
76+
"replace": "src/environments/environment.ts",
77+
"with": "src/environments/environment.prod.ts"
78+
}
79+
]
80+
}
81+
}
82+
},
83+
"serve": {
84+
"builder": "@angular-builders/custom-webpack:dev-server",
85+
"options": {
86+
"browserTarget": "angular-electron:build"
87+
},
88+
"configurations": {
89+
"dev": {
90+
"browserTarget": "angular-electron:build:dev"
91+
},
92+
"web": {
93+
"browserTarget": "angular-electron:build:web"
94+
},
95+
"production": {
96+
"browserTarget": "angular-electron:build:production"
97+
}
98+
}
99+
},
100+
"extract-i18n": {
101+
"builder": "@angular-devkit/build-angular:extract-i18n",
102+
"options": {
103+
"browserTarget": "angular-electron:build"
104+
}
105+
},
106+
"test": {
107+
"builder": "@angular-builders/custom-webpack:karma",
108+
"options": {
109+
"main": "src/test.ts",
110+
"polyfills": "src/polyfills-test.ts",
111+
"tsConfig": "src/tsconfig.spec.json",
112+
"karmaConfig": "src/karma.conf.js",
113+
"scripts": [],
114+
"styles": [
115+
"src/styles.scss"
116+
],
117+
"assets": [
118+
"src/assets"
119+
],
120+
"customWebpackConfig": {
121+
"path": "./angular.webpack.js"
122+
}
123+
}
124+
},
125+
"lint": {
126+
"builder": "@angular-eslint/builder:lint",
127+
"options": {
128+
"eslintConfig": ".eslintrc.json",
129+
"lintFilePatterns": [
130+
"src/**.ts",
131+
"main.ts"
132+
]
133+
}
134+
}
135+
}
136+
},
137+
"angular-electron-e2e": {
138+
"root": "e2e",
139+
"projectType": "application",
140+
"architect": {
141+
"lint": {
142+
"builder": "@angular-eslint/builder:lint",
143+
"options": {
144+
"eslintConfig": ".eslintrc.json",
145+
"lintFilePatterns": [
146+
"e2e/**.ts"
147+
]
148+
}
149+
}
150+
}
151+
}
152+
},
153+
"defaultProject": "angular-electron",
154+
"schematics": {
155+
"@schematics/angular:component": {
156+
"prefix": "app",
157+
"style": "scss"
158+
},
159+
"@schematics/angular:directive": {
160+
"prefix": "app"
161+
}
162+
}
163+
}

‎chat-client/angular.webpack.js

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/**
2+
* Custom angular webpack configuration
3+
*/
4+
5+
module.exports = (config, options) => {
6+
config.target = 'electron-renderer';
7+
config.optimization = {
8+
minimize: false
9+
};
10+
if (options.fileReplacements) {
11+
for (let fileReplacement of options.fileReplacements) {
12+
if (fileReplacement.replace !== 'src/environments/environment.ts') {
13+
continue;
14+
}
15+
16+
let fileReplacementParts = fileReplacement['with'].split('.');
17+
if (fileReplacementParts.length > 1 && ['web'].indexOf(fileReplacementParts[1]) >= 0) {
18+
config.target = 'web';
19+
}
20+
break;
21+
}
22+
}
23+
24+
return config;
25+
}

‎chat-client/electron-builder.json

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"productName": "angular-electron",
3+
"directories": {
4+
"output": "release/"
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.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/assets/icons",
30+
"target": [
31+
"dmg"
32+
]
33+
},
34+
"linux": {
35+
"icon": "dist/assets/icons",
36+
"target": [
37+
"AppImage"
38+
]
39+
}
40+
}

0 commit comments

Comments
 (0)