{"id":15017401,"url":"https://github.com/gazbert/bxbot-ui","last_synced_at":"2025-04-12T11:43:59.616Z","repository":{"id":140783093,"uuid":"66162801","full_name":"gazbert/bxbot-ui","owner":"gazbert","description":"An Angular app for administering BX-bot.","archived":false,"fork":false,"pushed_at":"2023-05-30T18:32:17.000Z","size":9576,"stargazers_count":21,"open_issues_count":8,"forks_count":20,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-26T06:34:23.298Z","etag":null,"topics":["angular","angular-sample","bxbot","jasmine","protractor","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/gazbert/bxbot","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gazbert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-20T18:50:15.000Z","updated_at":"2023-05-29T15:37:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"8c8629ac-5286-4f43-882a-4c1276daf3ab","html_url":"https://github.com/gazbert/bxbot-ui","commit_stats":{"total_commits":528,"total_committers":2,"mean_commits":264.0,"dds":0.02840909090909094,"last_synced_commit":"1bfe457668b87f61ef3d477a6799602db4e5c7d3"},"previous_names":["gazbert/bxbot-ui","gazbert/bxbot-ui-angular"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazbert%2Fbxbot-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazbert%2Fbxbot-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazbert%2Fbxbot-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazbert%2Fbxbot-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gazbert","download_url":"https://codeload.github.com/gazbert/bxbot-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248564089,"owners_count":21125405,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-sample","bxbot","jasmine","protractor","typescript"],"created_at":"2024-09-24T19:50:24.587Z","updated_at":"2025-04-12T11:43:59.597Z","avatar_url":"https://github.com/gazbert.png","language":"TypeScript","readme":"# BX-bot UI\n\n[![Node.js CI](https://github.com/gazbert/bxbot-ui/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/gazbert/bxbot-ui/actions/workflows/node.js.yml)\n\n**Note:** _This project is very much work in progress and not safe for production._\n\n## What is BX-bot UI?\n\n\u003cimg src=\"./docs/bxbot-ui-github-scaled.png\" align=\"right\" width=\"25%\" /\u003e\n\nBX-bot UI is an Angular app (and learning journey!) for administering [BX-bot](https://github.com/gazbert/bxbot).\n\nAlthough being developed as a 'real-world' app, the code _tries_ to showcase different features of Angular and \n[TypeScript](https://www.typescriptlang.org/). It's not meant to be an Angular 101 tutorial - the \n[Angular Documentation](https://angular.io/docs) does a far better job!\n\n## Installation Guide\n\n### The Docker way\nIf you want to just play around with the UI, Docker is the way to go.\n\n1. Install [Docker](https://docs.docker.com/engine/installation/) on the machine you want to run the app.\n1. Fetch the BX-bot image from [Docker Hub](https://hub.docker.com/r/gazbert/bxbot-ui/): `docker pull gazbert/bxbot-ui:0.0.1`\n1. Run the Docker container: `docker run --name bxbot-ui-0.0.1 -it --rm -p 4200:4200 gazbert/bxbot-ui:0.0.1`\n1. Open a browser and go to: `http://localhost:4200`\n1. You can stop the container using `CTRL-c`\n   \nThe current [Docker image](https://hub.docker.com/r/gazbert/bxbot-ui/tags/) is not a release, but rather a \nrolling development version of the UI...\n  \n### The manual way\nYou'll need [node.js](https://nodejs.org/en/download/) installed to build and run the app - it's being developed on 12.22.x.\n\n1. Install the [Angular CLI](https://cli.angular.io/) globally: `sudo npm install -g @angular/cli`\n1. Clone this repo locally.\n1. Change directory to the root of the project.\n1. Run `npm install` to install the dependencies - you'll only need to do this once, unless the versions are updated in \n   the [`package.json`](./package.json)\n1. To start the app: `npm start`\n1. Open a browser and go to: `http://localhost:4200`\n1. To stop the app, `CTRL-c` from the command line.\n\n## Build Guide\nFollow the instructions in the [_The manual way_](#the-manual-way) section if you've not already done so.\n\nThe project uses Angular CLI [commands](https://github.com/angular/angular-cli/wiki) to build, test, and run the app.\n\n### Building the App\n1. Run `npm run build` to compile the application into the `dist` output directory.                   \n\n### Jasmine Unit Tests\nThe app has behaviour-driven unit tests written using the excellent [Jasmine](https://jasmine.github.io/) framework. \n\n1. To run the tests once: `npm run test:once`\n1. To continuously run the tests in the background using [Karma](https://karma-runner.github.io/1.0/index.html):\n   `npm test` - Karma will monitor code changes and trigger re-running of the tests.\n1. To stop Karma, `CTRL-c` from the command line.\n\n### Protractor End-to-End Tests\nThe app has [e2e](e2e) tests written using [Protractor](http://www.protractortest.org).\n\n1. To run the tests once: `npm run e2e`. It's usually best not to have the app running at the same time.\n\n### TSLint \nThe build has a [TSLint](https://palantir.github.io/tslint/) script that checks for code readability, maintainability, and\nfunctionality errors. The [tslint.json](tslint.json) file contains the linting rules.\n\n1. To run the linter: `npm run lint`\n\n## Configuration\nThe app uses Angular's [In Memory Web API](https://github.com/angular/in-memory-web-api) as a replacement\nbackend for development and local testing. The API config configuration options are set in [`app.module.ts`](/src/app/app.module.ts).\n\nThe application config is in JSON format and lives in the [`in-memory-data.service.ts`](/src/app/model/in-memory-data.service.ts) file.\n\n## Contributing\nIssues and new features are managed using the project [Issue Tracker](https://github.com/gazbert/bxbot-ui/issues) -\nsubmit bugs here.\n\nYou are welcome to take on new features or fix bugs! See [here](CONTRIBUTING.md) for how to get involved.\n\n## Coming Soon\n* Integration with [BX-bot](https://github.com/gazbert/bxbot-ui).\n* A new 'Runtime' screen tab for displaying the bot's status, stopping/restarting, and viewing/downloading the latest log file.\n\n## Credits\nThis app started life as the [Angular 4 QuickStart](https://github.com/angular/quickstart) app and was later migrated to use \nthe [Angular CLI](https://github.com/angular/angular-cli/wiki/stories-moving-into-the-cli). \nIt took (a lot of) inspiration from the following:\n\n* The official [Angular Tutorial](https://angular.io/tutorial) and [Angular Style Guide](https://angular.io/docs/ts/latest/guide/style-guide.html).\n* Scotch tutorials by [Jecelyn Yeen](https://pub.scotch.io/@jecelyn).\n* Lots of insightful articles by (former) Angular dev [Victor Savkin](https://vsavkin.com/).\n* [Juri Strumpflohner's](https://juristr.com/blog/collections/angular/) Angular blogs.\n* Blog posts by [Thoughtram](http://blog.thoughtram.io/angular/2016/09/15/angular-2-final-is-out.html).\n* A great tutorial for adding [JWT authentication](http://chariotsolutions.com/blog/post/angular-2-spring-boot-jwt-cors_part2/)\n  to your Angular app by Rich Freedman.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazbert%2Fbxbot-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgazbert%2Fbxbot-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazbert%2Fbxbot-ui/lists"}