0.0.0 • Published 1 year ago

arb-design v0.0.0

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

Arb Design Library

Application pre-requisites

Install Node version 16.17.1

Application usage

Step 1: In project directory npm i

Step 2: In same directory run ng build arb-design-library --watch or npm run build arb-design-library --watch

Step 3: To run the project use ng serve or npm start

Implementation Guideline

For your guide we are using Atomic Design please check below link for more information

https://atomicdesign.bradfrost.com/chapter-2

Creating Components

To create atom component you need to go to the /projects/arb-design-library/src/lib/atom

To create molecule component you need to go to the /projects/arb-design-library/src/lib/molecule

Type command ng g c atom-name --inline-style

Creating Directive

To create atom directive you need to go to the /projects/arb-design-library/src/lib/atom

Type command ng g d atom-name --inline-style

Creating Documentation

To create documentation you need to go to the "/projects/arb-design-library"

Type command npm run compodoc

Running unit tests

Run ng test to execute the unit tests via Karma.

Running unit tests for Library

Run npm run test arb-design-library to run unit test for the library components

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The application 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.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.