0.0.0 • Published 6 years ago

@micduffy/search-bar v0.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

search bar

Build Status codecov npm version devDependency Status GitHub issues GitHub stars GitHub license

Demo

https://micduffy.github.io/search-bar/

Table of contents

About

Search Bar Test

Installation

Install through npm:

npm install --save search-bar

Then include in your apps module:

import { NgModule } from '@angular/core';
import { SearchBarModule } from 'search-bar';

@NgModule({
  imports: [
    SearchBarModule.forRoot()
  ]
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: '<hello-world></hello-world>'
})
export class MyComponent {}

You may also find it useful to view the demo source.

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://micduffy.github.io/search-bar/docs/

Development

Prepare your environment

  • Install Node.js and NPM
  • Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

  • Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release

License

MIT