mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 23:16:45 +00:00
7cacca1115
* Updated web/package.json and web/package-lock.json caused by 'npm i' * Resolved some vulnerabilities using 'npm audit fix' * Updated web dependency dotenv from 5.0.1 to 6.0.0 * Updated web dotenv package from 5.1.4 to 5.2.0 * Updated package core-js from 2.5.5 to 2.5.7 * Updated @angular/* dependencies from 6.0.4 to 6.0.7 * Added missing web test plugins karma-jasmine and krama-jasmine-html-reporter * Updated web rxjs* dependencies from 6.2.0 to 6.2.1 * Updated web package version to use the ^x.x.x notation for easier version management using npm * Updated web @amcharts/amcharts3-angular from 2.1.0 to 2.1.1 * Updated web electron-reload from 1.2.2 to 1.2.5 * Updated web karma to 2.0.4 and karma-coverage-istanbul-reporter to 1.4.3 * Updated rxjs-tslint from 0.1.4 to 0.1.5 * Updated web electron from 1.8.4 to 1.8.7 * Updated web npm-run-all from 4.1.2 to 4.1.3 * Updated web @types/jasmine @types/node @types/core-js packages to latest patch releases
111 lines
4.5 KiB
Markdown
111 lines
4.5 KiB
Markdown
# GoCryptoTrader package Web
|
|
|
|
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
|
|
[](https://travis-ci.org/thrasher-/gocryptotrader)
|
|
[](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-/gocryptotrader/web)
|
|
[](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
|
|
[](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
|
|
|
|
|
|
This web package is part of the GoCryptoTrader codebase.
|
|
|
|
## This is still in active development
|
|
|
|
You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader).
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/)
|
|
|
|
## Current Features
|
|
|
|
+ It can run
|
|
+ It can be compiled with Electron to run as an executable
|
|
+ Websocket support to listen to GoCryptoTrader events
|
|
+ Material design
|
|
+ Has a semi-working Settings page
|
|
+ Has a basic ticker dashboard
|
|
|
|
## 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 v5.2.5
|
|
- Angular-CLI v1.6.4
|
|
- Electron v1.8.7
|
|
- Electron Builder v20.0.4
|
|
|
|
|
|
## 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|
|
|
|
|
## Contribution
|
|
|
|
Please feel free to submit any pull requests or suggest any desired features to be added.
|
|
|
|
When submitting a PR, please abide by our coding guidelines:
|
|
|
|
+ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
+ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
+ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md).
|
|
+ Pull requests need to be based on and opened against the `master` branch.
|
|
|
|
## Donations
|
|
|
|
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
|
|
|
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
|
|
|
|
***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB***
|
|
|