mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-18 07:26:50 +00:00
74 lines
3.1 KiB
Markdown
74 lines
3.1 KiB
Markdown
## GoCryptoTrader website
|
|
A website interface to interact with the main gocryptotrader application
|
|
|
|
## Current Features
|
|
+ It can run... It is so incredibly basic right now
|
|
|
|
## Planned Features
|
|
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).
|
|
|
|
|
|
Install dependencies with npm :
|
|
|
|
``` bash
|
|
npm install
|
|
```
|
|
|
|
There is an issue with `yarn` and `node_modules` that are only used in electron on the backend when the application is built by the packager. Please use `npm` as dependencies manager.
|
|
|
|
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
|
|
|
|
- **in a terminal window** -> npm start
|
|
- **in another terminal window** -> npm run electron:serve
|
|
|
|
Voila! You can use your Angular + Electron app in a local development environment with hot reload !
|
|
|
|
The application code is managed by `main.ts`. In this sample, the app runs with a simple Electron window and "Developer Tools" is open.
|
|
The Angular component contains an example of Electron and NodeJS native lib import. See [Use NodeJS Native libraries](#use-nodejs-native-libraries) charpter if you want to import other native libraries in your project.
|
|
You can desactivate "Developer Tools" by commenting `win.webContents.openDevTools();` in `main.ts`.
|
|
|
|
## 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`
|
|
|
|
Your built files are in the /dist folder.
|
|
|
|
## Included Commands
|
|
|
|
|Command|Description|
|
|
|--|--|
|
|
|`npm run start:web`| Execute the app in the brower |
|
|
|`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 |
|
|
|
|
|
|
## Browser mode
|
|
|
|
Maybe you want to execute the application in the browser (WITHOUT HOT RELOAD ACTUALLY...) ? You can do it with `npm run start:web`.
|
|
Note that you can't use Electron or NodeJS native libraries in this case. Please check `providers/electron.service.ts` to watch how conditional import of electron/Native libraries is done.
|
|
|
|
## 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`
|
|
|
|
# Contributors
|
|
|[GloriousCode](https://github.com/gloriouscode)|
|
|
|[Shazbot](https://github.com/shazbert)|
|
|
|[Maxime GRIS](https://github.com/maximegris)|
|
|
|
|
|
|
|