doc: README.md

This commit is contained in:
eneller
2025-02-02 09:45:13 +01:00
committed by GitHub
parent 83bfe51282
commit 55bea1a923

View File

@@ -1,8 +1,7 @@
# Vb
A Team Randomizer built using Angular, installable as a progressive web app (PWA).
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.2.
## Development server
## Development
To start a local development server, run:
@@ -12,20 +11,6 @@ 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 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:
@@ -34,7 +19,8 @@ To build the project run:
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.
This will compile your project and store the build artifacts in the `dist/` directory.
As this is a static site, simply move the contents of browser/ to a directory that can be served by nginx or apache.
## Running unit tests
@@ -43,17 +29,3 @@ To execute unit tests with the [Karma](https://karma-runner.github.io) test runn
```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.
## 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.