https://github.com/dkarter/portfolio-react
https://github.com/dkarter/portfolio-react
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dkarter/portfolio-react
- Owner: dkarter
- Created: 2015-08-16T21:50:11.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T04:13:10.000Z (over 2 years ago)
- Last Synced: 2025-02-25T13:54:53.130Z (over 1 year ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-portfolio
__COMPONENT DESCRIPTION GOES HERE__
## Demo & Examples
Live demo: [dkarter.github.io/react-portfolio](http://dkarter.github.io/react-portfolio/)
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-portfolio 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-portfolio.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-portfolio --save
```
## Usage
__EXPLAIN USAGE HERE__
```
var ReactPortfolio = require('react-portfolio');
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 Dorian Karter.