diff --git a/README.md b/README.md index 2a402fe7..34306893 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,10 @@ When submitting a PR, please abide by our coding guidelines: ## Compiling instructions -Download and install Go from [Go Downloads](https://golang.org/dl/) +Download and install Go from [Go Downloads](https://golang.org/dl/) for your +platform. + +### Linux/OSX ```bash go get github.com/thrasher-/gocryptotrader @@ -82,8 +85,17 @@ go install cp $GOPATH/src/github.com/thrasher-/gocryptotrader/config_example.json $GOPATH/bin/config.json ``` -Make any neccessary changes to the config file. -Run the application! +### Windows + +```bash +go get github.com/thrasher-/gocryptotrader +cd %GOPATH%\src\github.com\thrasher-\gocryptotrader +go install +copy %GOPATH%\src\github.com\thrasher-\gocryptotrader\config_example.json %GOPATH%\bin\config.json +``` + ++ Make any neccessary changes to the `config.json` file. ++ Run the `gocryptotrader` binary file inside your GOPATH bin folder. ## Donations diff --git a/web/README.md b/web/README.md index c6d8d83d..5d02a2d0 100644 --- a/web/README.md +++ b/web/README.md @@ -1,11 +1,15 @@ -## GoCryptoTrader website -![Snazzy logo](/src/assets/page-logo.png "Optional title") +# GoCryptoTrader Website + + + A website interface to interact with the main GoCryptoTrader application. It is developed with Angular 4 with support for Electron ## 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). ## Current Features + + It can run + It can be compiled with Electron to run as an executable + Websocket support to listen to GoCryptoTrader events @@ -13,15 +17,13 @@ A website interface to interact with the main GoCryptoTrader application. It is + Has a semi-working Settings page + Has a basic ticker dashboard - - -## Install dependencies with npm : +## 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. +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 @@ -29,15 +31,17 @@ npm install -g @angular/cli ``` ## To build for development + +``` bash npm run start:web +``` Voila! You can use GoCryptoTrader web app in a local development environment with webpack watching! - ## 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` ++ Using development variables (environments/index.ts) : `npm run electron:dev` ++ Using production variables (environments/index.prod.ts) : `npm run electron:prod` Your built files are in the /dist folder. @@ -50,22 +54,19 @@ Your built files are in the /dist folder. |`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 | - ## 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` +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` + +## Contributors -# 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| - - - - +|Shazbert|https://github.com/shazbert |Initial designs| \ No newline at end of file