d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-26 15:10:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README template files and regenerated documentation. (#125)

Browse Source
This commit is contained in:
Ryan O'Hara-Reid
2018-05-14 10:03:17 +10:00
committed by Adrian Gallagher
parent cbc531ca2c
commit dc11f87b8b
48 changed files with 79 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tools/documentation/readme_templates/root_readme.tmpl
View File

@@ -127,7 +127,7 @@ copy %GOPATH%\src\github.com\thrasher-\gocryptotrader\config_example.json %GOPAT
## Donations
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70">
<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:

36
tools/documentation/readme_templates/web_readme.tmpl
View File

@@ -28,32 +28,40 @@ npm install -g @angular/cli
npm run start:web
```
Voila! You can use GoCryptoTrader web app in a local development environment with webpack watching!
Currently runs with:
- Angular v5.2.5
- Angular-CLI v1.6.4
- Electron v1.8.2
- Electron Builder v20.0.4
## To build for production
+ Using development variables (environments/index.ts) : `npm run electron:dev`
+ Using production variables (environments/index.prod.ts) : `npm run electron:prod`
- **in a terminal window** -> npm start
Your built files are in the /dist folder.
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 start:web`| Execute the app in the brower |
|`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 Ma |
|`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 |
## Execute E2E tests
You can find end-to-end tests in /e2e folder.
You can run tests with the command lines below:
+ **in a terminal window** -> First, start a web server on port 4200 : `npm run start:web`
+ **in another terminal window** -> Then, launch Protractor (E2E framework): `npm run e2e`
**Your application is optimised. Only /dist folder and node dependencies are included in the executable.**
## Contributors

2
tools/documentation/sub_templates/donations.tmpl
View File

@@ -1,7 +1,7 @@
{{define "donations" -}}
## Donations
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/early-dumb-donate.png?raw=true" hspace="70">
<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: