gswrx-uilib v0.0.7

Getting started

The gswrx-uilib is a component library for Angular which contains reusable components made and used internally in gswrx. gswrx-uilib has been made open-source for the purpose of providing (reusable) components to developers in the open-source community, while users themselves can contribute to the project where needed.

Using the library

gswrx-uilib is available through the npm package manager for now and will be added to yarn in the near future.

npm i --save gswrx-uilib

After installing the dependency into your local project, you will be able to use any of the components provided in the library. See the list of components available below.

Developing components for this library

The workflow of adding new components to this library looks as follows:

1. Generate new module into the /modules/ folder (ng g module /modules/Module-name)
2. Generate new component into the /components/ --module=modules/*/Module-name* --export=true

Reserved for the workflow of developing components for this library, explaining the directory structure, steps to take to make the component available for external use (order of generation, command flags, pull requests)

Maintaining the library

Reserved for the workflow of maintaining this library using npm scripts

little bit about documentation

Testing & Tooling

Reserved for a description on tooling (soon to be) used for this library(Test coverage, git hooks, TravisCI, npm scripts) so whoever maintains this project has a certain workflow based on a set of rules for future development

Components

Reserved for a list of existing components in this library and their corresponding documentation

To do

Uilib

This project was generated with Angular CLI version 8.3.4.

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. Use the --prod flag for a production build.

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

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.