https://github.com/chantastic/react-card-object
A React card implementation with inline styles
https://github.com/chantastic/react-card-object
Last synced: about 1 year ago
JSON representation
A React card implementation with inline styles
- Host: GitHub
- URL: https://github.com/chantastic/react-card-object
- Owner: chantastic
- Created: 2015-09-16T18:55:11.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-09-24T05:46:45.000Z (over 9 years ago)
- Last Synced: 2025-04-03T23:33:10.967Z (about 1 year ago)
- Language: JavaScript
- Size: 157 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Card Object
__COMPONENT DESCRIPTION GOES HERE__
## Demo & Examples
Live demo: [chantastic.github.io/react-card-object](http://chantastic.github.io/react-card-object/)
To build the examples locally, run:
```
npm install
npm start
```
Then open [`localhost:8000`](http://localhost:8000) in a browser.
## Installation
The easiest way to use react-card-object is to install it from NPM and include it in your own React build process (using [Browserify](http://browserify.org), [Webpack](http://webpack.github.io/), etc).
You can also use the standalone build by including `dist/react-card-object.js` in your page. If you use this, make sure you have already included React, and it is available as a global variable.
```
npm install react-card-object --save
```
## Usage
__EXPLAIN USAGE HERE__
```
var ReactCardObject = require('react-card-object');
Example
```
### Properties
* __DOCUMENT PROPERTIES HERE__
### Notes
__ADDITIONAL USAGE NOTES__
## Development (`src`, `lib` and the build process)
**NOTE:** The source code for the component is in `src`. A transpiled CommonJS version (generated with Babel) is available in `lib` for use with node.js, browserify and webpack. A UMD bundle is also built to `dist`, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run `npm start`. If you just want to watch changes to `src` and rebuild `lib`, run `npm run watch` (this is useful if you are working with `npm link`).
## License
__PUT LICENSE HERE__
Copyright (c) 2015 Michael Chan.