mirror of
https://github.com/valitydev/dashboard.git
synced 2024-11-06 18:45:17 +00:00
65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
# Dashboard
|
|
|
|
## Libraries
|
|
|
|
- [Angular CLI](https://github.com/angular/angular-cli)
|
|
- Run `ng generate component component-name` to generate a new component (you can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`).
|
|
- To get more help use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
|
|
- [Angular Material](https://material.angular.io/)
|
|
- [Prettier](https://prettier.io/)
|
|
|
|
## Initialization
|
|
|
|
```sh
|
|
# Install packages
|
|
|
|
npm ci
|
|
|
|
# Generate swagger API Angular modules
|
|
|
|
npm run codegen
|
|
```
|
|
|
|
## Development server
|
|
|
|
1. Run `npm start`
|
|
1. Navigate to `http://localhost:8000/`
|
|
|
|
## Production build
|
|
|
|
1. Run `npm run build`
|
|
1. The build artifacts will be stored in the `dist/` directory.
|
|
|
|
## Add API
|
|
|
|
1. Add submodule
|
|
|
|
```sh
|
|
git submodule -b <SCHEME_BRANCH> add <SCHEME_REPO> schemes/<SCHEME_NAME>/<VER:VX>
|
|
```
|
|
|
|
1. Add submodule directory (`schemes/<SCHEME_NAME>/<VER:VX>`) to Makefile `SWAGGER_SCHEMES_PATH`
|
|
1. [Generate swagger API Angular modules](#initialization)
|
|
1. Update `config.json` and `stub-config.json`
|
|
1. Add `src/api/<SCHEME_NAME>`:
|
|
- `index.ts`
|
|
- `<SCHEME_NAME>.module.ts`
|
|
- `<SCHEME_NAME>-config.service.ts`
|
|
|
|
## Tests
|
|
|
|
- Run `npm run test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
|
- Run `npm run e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
|
|
|
|
## Utils
|
|
|
|
### Analyze bundle size
|
|
|
|
npm run build -- --prod --stats-json --extraWebpackConfig webpack.extra.js
|
|
npx webpack-bundle-analyzer dist/stats.json
|
|
|
|
## Guides
|
|
|
|
- [Using typography](https://material.angular.io/guide/typography)
|
|
- [Theming your components](https://material.angular.io/guide/theming-your-components)
|