node package manager

@mitchallen/react-card-grey

@mitchallen/react-card-grey

CardGrey React component

Continuous Integration Coverage Status Downloads Version License

Installation

$ npm init
$ npm install @mitchallen/react-card-grey --save

Usage

1: Add this line near the top of your file (like src/App.js):

import CardGrey from '@mitchallen/react-card-grey';

NOTE: CardGrey must be Capitalized or component won't render.

2: Somewhere in the middle of the render method add this line:

<CardGrey />

Testing

Run the Tests

To test, go to the root folder and type (sans $):

$ npm test

Component Testing

Prerequisite

If you've never installed create-react-app (you may need to use sudo):

$ npm install -g create-react-app

Create a local npm link

In the original component folder (you may need to use sudo):

$ npm link

Create a test package

Create a root test folder and then do the following:

$ create-react-app react-card-grey-test
$ cd react-card-grey-test
$ npm link @mitchallen/react-card-grey

Modify src/App.js

1: Add this line near the top:

import CardGrey from '@mitchallen/react-card-grey';

NOTE: CardGrey must be Capitalized or component won't render.

2: Somewhere in the middle of the render method add this code:

<CardGrey>
    <p style={{ color: '#FFFFFF'}}>Hello World!</p>
</CardGrey>
<CardGrey />

Run The Test App

$ npm start

Cleanup

Remember to unlink when done.


Repo(s)


Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.


Version History

Version 0.1.6

  • Fixed command in .circleci/config.yml

Version 0.1.5

  • Added run: yarn add react to .circleci/config.yml

Version 0.1.4

  • Removed duplicate react dependency, now only exists in peerDependencies
  • Replace reference to React.PropType with ref to prop-types
  • Cleaned up test case

Version 0.1.3

  • Added examples folder with example

Version 0.1.2

  • Fixed index reference in package.json

Version 0.1.1

  • Switched badge to CircleCI

Version 0.1.0

  • initial release