@dotgov/core

• Getting started

• Roadmap

• API

• Contributors

• Development

Warning

Library is under active development and may have breaking changes until stable 2.0.0 release or subsequent major versions after 2.0.0.

Getting started

Step 1: Install @dotgov/core

NPM

```shell npm install --save @dotgov/core ```

Step 2: Import the component module

```js import { DGSCoreModule, IDGSEnvironment } from '@dotgov/core'; const dgsEnvironment: IDGSEnvironment = { debug: environment.debug, apiUrl: environment.apiUrl, defaultLanguage: {

Name: 'English',

Code: 'en',

Icon: 'fa fa-globe',

}, languages: {

Name: 'English',

Code: 'en',

Icon: 'fa fa-globe',

}],

lowerCaseTranslates: true, }; @NgModule({ declarations: AppComponent, imports: DGSCoreModule.forRoot(dgsEnvironment), bootstrap: AppComponent }) export class AppModule {} ```

Contributors

| Contributor Name | Contributor Page | | ------------- | ------------- | | Grigore Meleca | grigoreme |

Development

Setup build path

Open ng-package.json and setup dest to location where you want your build to go. (example: ../myProject/node_modules/@dotgov/core)

Build

```shell npm run build ``` For more information read docs/developer_guide.md

Release

To release to npm just run npm run release, of course if you have permissions ;)

Inspiration

Thanks to ng-select for README inspiration.