saurabhnemade / ng2-testimonial

Angular 2 Testimonial Component

ng2-component-starter

This repository is a starting point to build reuseable and testable Angular 2 components.

Features

• Angular 2.0.1
• TypeScript 2
• Type management with NPM (@types)
• Demo application that shows the component(s) in action
  • webpack
• Linter's to follow the official Angular 2 Style Guide through Codelyzer

Installation

1. Clone the repository
   git clone https://github.com/axa-ch/ng2-component-starter.git
2. Change directory to ng2-component-starter
   cd ng2-component-starter
3. Install global node module dependencies
   npm install webpack protractor rimraf -g
4. Run npm install to install local node-module dependencies

Commands

• npm run demo - Run demo to see sample components in action (visit http://localhost:3000)

Making a component

Cleanup checklist

This starter project could have some items / settings you probably want to remove or adjust. This checklist helps you to review your component needs.

• Fork repository to your own account or wherever you want
• Clone your repository locally
• Refactor README.md in main folder
  1. This includes refactoring repo-clone link
  2. This includes refactoring gitter link and (dev)Dependency status links
• Edit package.json
  1. Edit different properties such as name, description, repository-url and further more
• Edit demo/index.html
  1. Author link
  2. Meta description
• Edit demo/components/clock-section.component.ts
  1. ClockSectionComponent src property
• Edit demo/components/getting-started-section/getting-started-section.component.html
  1. iframe src
• Edit demo/components/getting-started-section/getting-started-section.component.ts
  1. name property
• Implement your new component

Publish your component to the offical npm registry

If you would like to publish your component to the @axa-ch scope, you have to log in to this account using npm. See contact information on npmjs.

1. npm login - Then enter user and password and email
2. npm publish --access public - Publishes the repo.
3. Consider adding your personal npmjs user as contributor to the newly published repository. So you can continue working with your personal account.

ng2-your-component

[Describe your component here. Mention dependencies to other modules/components here if neccessary.]

Installation

[Required steps to make your component ready to use]

npm install ng2-your-component --save

Demo

[Link to a location, where to see your component in action]

Usage

[How to use your component. How to get started quickly.]

CommonJS

ng2-your-component ships as un-bundled CommonJS modules (located in the dist folder), which can be imported with require('ng2-your-component');, or import for those environments that support this method (e.g. TypeScript 1.6+).

System.register

ng2-your-component also ships with a bundle in the system format (dist/ng2-your-component-bundle.js), suitable for use with the es6-module-loader and related loaders such as SystemJS.

API

[Refer to API documentation of your component. Cosider doing this in the GitHub wiki.]

ng2-testimonial's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.