https://github.com/phillipcurl/ngx-cards

A collection of functional UI components for building multimedia cards in Angular apps
https://github.com/phillipcurl/ngx-cards

Last synced: about 1 month ago
JSON representation

A collection of functional UI components for building multimedia cards in Angular apps

• Host: GitHub
• URL: https://github.com/phillipcurl/ngx-cards
• Owner: phillipcurl
• License: mit
• Created: 2017-01-22T18:09:41.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-22T18:16:06.000Z (about 8 years ago)
• Last Synced: 2024-11-15T08:48:31.333Z (3 months ago)
• Language: JavaScript
• Size: 1.34 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WIP: DO NOT USE YET

# ngx-cards

[![Build Status](https://travis-ci.org/phillipcurl/ngx-cards.svg?branch=master)](https://travis-ci.org/phillipcurl/ngx-cards)

[![npm version](https://badge.fury.io/js/ngx-cards.svg)](http://badge.fury.io/js/ngx-cards)

[![devDependency Status](https://david-dm.org/phillipcurl/ngx-cards/dev-status.svg)](https://david-dm.org/phillipcurl/ngx-cards?type=dev)

[![GitHub issues](https://img.shields.io/github/issues/phillipcurl/ngx-cards.svg)](https://github.com/phillipcurl/ngx-cards/issues)

[![GitHub stars](https://img.shields.io/github/stars/phillipcurl/ngx-cards.svg)](https://github.com/phillipcurl/ngx-cards/stargazers)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/phillipcurl/ngx-cards/master/LICENSE)

## Demo

https://phillipcurl.github.io/ngx-cards/demo/

## Table of contents

- [About](#about)

- [Installation](#installation)

- [Documentation](#documentation)

- [Development](#development)

- [License](#license)

## About

A collection of functional UI components for building multimedia cards in Angular apps

## Installation

Install through npm:

```

npm install --save ngx-cards

```

Then include in your apps module:

```typescript

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

import { NgxCardsModule } from 'ngx-cards';

@NgModule({

  imports: [

    NgxCardsModule.forRoot()

  ]

})

export class MyModule {}

```

Finally use in one of your apps components:

```typescript

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

@Component({

  template: ''

})

export class MyComponent {}

```

You may also find it useful to view the [demo source](https://github.com/phillipcurl/ngx-cards/blob/master/demo/demo.component.ts).

### Usage without a module bundler

```

    // everything is exported ngxCards namespace

```

## Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here:

https://phillipcurl.github.io/ngx-cards/docs/

## Development

### Prepare your environment

* Install [Node.js](http://nodejs.org/) and NPM (should come with)

* 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)

```bash

npm run release

```

## License

MIT