Files
gocryptotrader/cmd/documentation/web_templates/web_readme.tmpl
2019-08-09 15:46:24 +10:00

67 lines
2.4 KiB
Cheetah

{{define "web" -}}
{{template "header" .}}
# The Angular version of the front-end is being replaced by a React implementation on this branch: https://github.com/thrasher-corp/gocryptotrader/tree/react-web/web
### There will be no further development on the Angular front end and all development should be directed to the new branch until it is merged.
## Install dependencies with npm
``` bash
npm install
```
If you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context.
Please follow [Angular-cli documentation](https://github.com/angular/angular-cli) if you had installed a previous version of `angular-cli`.
``` bash
npm install -g @angular/cli
```
## To build for development
``` bash
npm run start:web
```
Currently runs with:
- Angular v7
## To build for production
- **in a terminal window** -> npm start
Voila! You can use your Angular + Electron app in a local development environment with hot reload !
## Manage your environment variables
- Using local variables : `npm start` or `cross-env ENV=local npm start`
- Using development variables : `cross-env ENV=dev npm start`
- Using production variables : `cross-env ENV=prod npm start`
## Included Commands
|Command|Description|
|--|--|
|`npm run ng:serve`| Execute the app in the browser |
|`npm run start:web`| Execute the app in the browser |
|`npm run build`| Build the app. Your built files are in the /dist folder. |
|`npm run build:prod`| Build the app with Angular aot. Your built files are in the /dist folder. |
|`npm run electron:local`| Builds your application and start electron
|`npm run electron:linux`| Builds your application and creates an app consumable on linux system |
|`npm run electron:windows`| On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems |
|`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 |
**Your application is optimised. Only /dist folder and node dependencies are included in the executable.**
## Contributors
|User|Github|Contribution|
|--|--|--|
|GloriousCode|https://github.com/gloriouscode |Lead front-end|
|Maxime GRIS|https://github.com/maximegris |Angular4 + Electron Base|
|Shazbert|https://github.com/shazbert |Initial designs|
{{template "contributions"}}
{{template "donations"}}
{{end}}