olierxleben / ngx-octicons

angularistic wrapper around Octicon Icons

NgxOcticons

This is a little library to provide an angularistic interface (a directive) in apps. The repository contains of an angular workspace which contains two applications:

1. ngx-octicons, the library
2. demo, the development app

usage

to install, simply

npm install --save ngx-octicons

Afterwards just import the Module into your Application

import { NgxOcticonsModule } from 'ngx-octicons';


@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgxOcticonsModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Development

To build library

npx ng build ngx-octicons --watch

to run dev server

npx ng serve 

building using prod flag + publishing

npx ng build --prod 

publishing

npm run pub

Made with ng CLI

This project was generated with Angular CLI version 8.3.7.

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.