mirror of
https://github.com/Kareadita/Kavita.git
synced 2026-04-28 03:40:38 -04:00
53 lines
2.5 KiB
Markdown
53 lines
2.5 KiB
Markdown
# Kavita Webui
|
|
|
|
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.0.0.
|
|
|
|
## Development server
|
|
|
|
Run `npm run start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
|
|
Your backend must be served on port 5000.
|
|
|
|
## Code scaffolding
|
|
|
|
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`.
|
|
|
|
## Build
|
|
|
|
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
|
|
|
|
|
|
## Localization Scripts
|
|
- audit-i18n.js (ran via `npm run audit-i18n`)
|
|
- Performs Duplicate key detection
|
|
- Cross-Reference Validation ({common.roles}}, {{common.copy}}, {{common.required-field}} don't exist in en.json)
|
|
- Dead Keys - Potentially finds dead keys. Some dynamically created keys may be false-positive, use `i18n-dynamic-keys.json` to whitelist prefixes
|
|
- Locale Sync - Shows missing/empty/extra key counts per locale.
|
|
- Outputs to i18n-audit-report.json
|
|
- /locale-preview
|
|
- An authenticated page to let any authenticated user see locales and ensure their target language has all necessary keys
|
|
|
|
## Connecting to your dev server via your phone or any other compatible client on local network
|
|
|
|
Run `npm run start-proxy`
|
|
|
|
## Testing OIDC
|
|
|
|
There's two options,
|
|
|
|
1) Run the proxy and correct the port after redirect (on login).
|
|
2) Run `build-backend` or `build-backend-prod`, and use `localhost:5000` to test. This requires you to rebuild after each change
|
|
|
|
Do **NOT** commit appsettings.development.json while testing OIDC. It'll contain your secret key
|
|
|
|
## Notes:
|
|
- injected services should be at the top of the file
|
|
- all components must be standalone
|
|
|
|
# Update latest angular
|
|
`ng update @angular/core @angular/cli @typescript-eslint/parser @angular/localize @angular/compiler-cli @angular/cdk @angular/animations @angular/common @angular/forms @angular/platform-browser @angular/platform-browser-dynamic @angular/router`
|
|
|
|
`npm install @angular-eslint/builder@latest @angular-eslint/eslint-plugin@latest @angular-eslint/eslint-plugin-template@latest @angular-eslint/schematics@latest @angular-eslint/template-parser@latest`
|
|
|
|
# Update Localization library
|
|
`npm install @jsverse/transloco@latest @jsverse/transloco-locale@latest @jsverse/transloco-persist-lang@latest @jsverse/transloco-persist-translations@latest @jsverse/transloco-preload-langs@latest`
|