BX-bot UI

What is BX-bot UI?

BX-bot UI is a learning project and simple Angular 2 sample app for administering a Bitcoin trading bot.

Very much work in progress, but this is where we're heading...

Although being developed as a 'real-world' app, the code tries to showcase different features of Angular 2 and TypeScript. It's not meant to be an Angular 101 tutorial - the main Angular Documentation does a far better job! It's more of a cookbook/sample app for experienced devs wanting to give Angular a whirl.

User Guide

You'll need node.js installed to build and run the app.

1. Clone the repo locally.
2. Change directory to the root of project.
3. Run npm install to install the dependencies - you'll only need to do this once, unless the versions are updated in the package.json.
4. To start the app: npm start - a browser window should open with the app up and running...
5. To stop the app, Ctrl-C from the command line.

Jasmine Unit Tests

The app has behaviour-driven unit tests written using the excellent Jasmine framework.

1. To run the tests once: npm run test:once
2. To continuously run the tests in the background using Karma: npm test - Karma will monitor code changes and trigger re-running of the tests.
3. To stop Karma, Ctrl-C from the command line.

Protractor End-to-End Tests

The app has e2e tests written using Protractor.

1. To run the tests once: npm run e2e. It's usually best not to have the app running at the same time.

TSLint

The build has a TSLint script that checks for code readability, maintainability, and functionality errors.

1. To run the linter: npm run lint

Configuration

The app uses Angular's In Memory Web API as a replacement backend for development and local testing. The API config configuration options are set in app.module.ts.

The application config is in JSON format and lives in the in-memory-data.service.ts file.

Credits

This app started life as the Angular 2 QuickStart app and took (a lot of) inspiration from the following awesomeness:

• The official Angular Tutorial.
• The Angular Style Guide.
• Scotch tutorials by Jecelyn Yeen.
• Lots of insightful articles by (former) Angular dev Victor Savkin.
• Juri Strumpflohner's Angular blogs.
• Blog posts by Thoughtram.