Herd-UI is frontend for Herd and can be configured to point to any compatible Herd instance. It is developed using Angular-CLI, Angular, Bootstrap 4, and TypeScript.
Herd-UI uses Angular CLI version 1.6.x for local development. To get more help on the Angular CLI use ng help or check out the Angular CLI README.
While developing in your local machine you can run ng serve for a dev server and then navigate to http://localhost:4200/ to see Herd-UI running in your local machine. The app will automatically reload if you change any of the source files.
Angular cli gives us the capability of generating new components, directives, pipes, etc. through command prompt
you can simply run ng generate component component-name to generate a new component.
You can also use ng generate directive/pipe/service/class/module.
To build, test and run the project, there any many npm s configured in package.json. You can run those commands to develop, test and deploy code into server.
The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build. and then you can configure your CI to place your build code in to your server.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.
Before running the tests make sure you are serving the app via ng serve or point to any deployed server.
These are currently not setup to run in an Open Source context but we will iterate over the test configuration to make sure we have this in the future.
FINRA data management team is currently developing, supporting and enhancing the Herd-UI project. You can raise a bug or feature in the github issue page or contact team for specific features or bugs.