CopilotandTHoguet
f7bd101fb7
* Initial plan * Add comprehensive CI/CD workflows and tooling - Add PR validation workflow with lint, format, type check, test, and build steps - Improve Docker build workflow with caching, security scanning, and manual trigger - Add CodeQL security analysis workflow - Add Dependabot configuration for automated dependency updates - Configure ESLint with TypeScript support - Add npm scripts for linting and formatting - Format code with Prettier - Fix linting issues in source code Co-authored-by: THoguet <61246905+THoguet@users.noreply.github.com> * Update README and fix build configuration - Add CI/CD documentation to README - Document code quality tools and scripts - Disable font optimization in production build to avoid network dependency - Add build cache configuration for GitHub Actions Co-authored-by: THoguet <61246905+THoguet@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: THoguet <61246905+THoguet@users.noreply.github.com>
101 lines
2.2 KiB
Markdown
101 lines
2.2 KiB
Markdown
# VacOptimizer
|
|
|
|
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.7.
|
|
|
|
## Development server
|
|
|
|
To start a local development server, run:
|
|
|
|
```bash
|
|
ng serve
|
|
```
|
|
|
|
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
|
|
|
|
## Code Quality
|
|
|
|
This project uses ESLint and Prettier to maintain code quality and consistency.
|
|
|
|
### Linting
|
|
|
|
Check for linting errors:
|
|
|
|
```bash
|
|
npm run lint
|
|
```
|
|
|
|
Auto-fix linting issues:
|
|
|
|
```bash
|
|
npm run lint:fix
|
|
```
|
|
|
|
### Formatting
|
|
|
|
Check code formatting:
|
|
|
|
```bash
|
|
npm run format:check
|
|
```
|
|
|
|
Format code:
|
|
|
|
```bash
|
|
npm run format
|
|
```
|
|
|
|
## Code scaffolding
|
|
|
|
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
|
|
|
```bash
|
|
ng generate component component-name
|
|
```
|
|
|
|
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
|
|
|
|
```bash
|
|
ng generate --help
|
|
```
|
|
|
|
## Building
|
|
|
|
To build the project run:
|
|
|
|
```bash
|
|
ng build
|
|
```
|
|
|
|
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
|
|
|
|
## Running unit tests
|
|
|
|
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
|
|
|
|
```bash
|
|
ng test
|
|
```
|
|
|
|
## Running end-to-end tests
|
|
|
|
For end-to-end (e2e) testing, run:
|
|
|
|
```bash
|
|
ng e2e
|
|
```
|
|
|
|
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
|
|
|
|
## CI/CD
|
|
|
|
This project uses GitHub Actions for continuous integration and deployment:
|
|
|
|
- **PR Validation**: Automatically runs on pull requests to validate code quality, run tests, and build the application
|
|
- **Docker Build & Push**: Builds and publishes Docker images to GitHub Container Registry on main branch pushes and releases
|
|
- **CodeQL Analysis**: Runs security analysis weekly and on pull requests
|
|
- **Dependabot**: Automatically updates dependencies weekly
|
|
|
|
## Additional Resources
|
|
|
|
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|