Skip to content

tfobz/carbon-calculator

Repository files navigation

Carbon Calculator

Documentation Coverage Lines of code

Table of contents

Setup this project:

- Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

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

- Running unit tests

Run ng test to execute the unit tests via Karma.

- Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

- Deploy github-pages

Run npm run deploy to execute the deploy for Github-pages.

Documentation

The documentation has been created using Compodoc, a powerful open-source tool to automatically generate html documentation from comments in the Angular project.
You can create your own HTML documentation using the command npm run compodoc and you will find the index.html file in the documentation folder.
WARNING! Here on Github the documentation is auto-generated on every commit and has its own branch
Also, make sure you follow the Guidelines!

Further help

This project was generated with Angular CLI version 14.2.6.
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.