Skip to content

Latest commit

 

History

History

web

README.md

GoCryptoTrader package Web

Build Status Software License GoDoc Coverage Status Go Report Card

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.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

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

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 if you had installed a previous version of angular-cli.

npm install -g @angular/cli

To build for development

npm run start:web

Currently runs with:

  • Angular v6.0.9
  • Angular-CLI v6.0.8
  • 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 guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB