Skip to content
Snippets Groups Projects
README.md 2.69 KiB
Newer Older
Hugo SUBTIL's avatar
Hugo SUBTIL committed
[![Quality Gate Status](https://sonarqube.forge.grandlyon.com/api/project_badges/measure?project=pamn_client&metric=alert_status)](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client)
[![Bugs](https://sonarqube.forge.grandlyon.com/api/project_badges/measure?project=pamn_client&metric=bugs)](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client)
[![Lines of Code](https://sonarqube.forge.grandlyon.com/api/project_badges/measure?project=pamn_client&metric=ncloc)](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client)
[![Maintainability Rating](https://sonarqube.forge.grandlyon.com/api/project_badges/measure?project=pamn_client&metric=sqale_rating)](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client)
[![Security Rating](https://sonarqube.forge.grandlyon.com/api/project_badges/measure?project=pamn_client&metric=security_rating)](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client)
[![Vulnerabilities](https://sonarqube.forge.grandlyon.com/api/project_badges/measure?project=pamn_client&metric=vulnerabilities)](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client)
Hugo SUBTIL's avatar
Hugo SUBTIL committed
# Pamn

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.1.3.

Bastien DUMONT's avatar
Bastien DUMONT committed
## Wikis

Find [here](https://forge.grandlyon.com/web-et-numerique/pamn_plateforme-des-acteurs-de-la-mediation-numerique/pamn_client/-/wikis/home) wikis about useful informations like installation and gitflow.

Hugo SUBTIL's avatar
Hugo SUBTIL committed
## Development server

Hugo SUBTIL's avatar
Hugo SUBTIL committed
Run `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
Hugo SUBTIL's avatar
Hugo SUBTIL committed

## 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

Hugo SUBTIL's avatar
Hugo SUBTIL committed
Run `npm run build:dev` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `npm run build:prod` flag for a production build.
Hugo SUBTIL's avatar
Hugo SUBTIL committed

## Running unit tests

Hugo SUBTIL's avatar
Hugo SUBTIL committed
Run `npm run test` to execute the unit tests via [Karma](https://karma-runner.github.io).
Hugo SUBTIL's avatar
Hugo SUBTIL committed

## Running end-to-end tests

Hugo SUBTIL's avatar
Hugo SUBTIL committed
Run `npm run e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
Hugo SUBTIL's avatar
Hugo SUBTIL committed

## Contributing

Use conventional commit format. For more info please read this article on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
Hugo SUBTIL's avatar
Hugo SUBTIL committed

Bastien DUMONT's avatar
Bastien DUMONT committed
## Documentation

A documentation is generated with compodoc in addition of the existing documentation on the wiki.
Bastien DUMONT's avatar
Bastien DUMONT committed

```sh
npm run doc:serve
```
Bastien DUMONT's avatar
Bastien DUMONT committed

You can now visualize it at : `localhost:8080`
Bastien DUMONT's avatar
Bastien DUMONT committed

Hugo SUBTIL's avatar
Hugo SUBTIL committed
## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).