https://github.com/CodeDraken/react-ipsum

React lorem ipsum components library
https://github.com/CodeDraken/react-ipsum

Last synced: 3 months ago
JSON representation

React lorem ipsum components library

• Host: GitHub
• URL: https://github.com/CodeDraken/react-ipsum
• Owner: CodeDraken
• License: mit
• Created: 2018-09-24T04:46:16.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-10-03T20:14:54.000Z (over 4 years ago)
• Last Synced: 2024-03-20T03:02:01.305Z (3 months ago)
• Language: JavaScript
• Size: 779 KB
• Stars: 7
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-hacktoberfest - React Ipsum

README

        

# React Ipsum

[![Build Status](https://travis-ci.com/CodeDraken/react-ipsum.svg?branch=master)](https://travis-ci.com/CodeDraken/react-ipsum)

React Lorem Ipsum components to be used as placeholders in designs.

## Components

View the components in a [Storybook here](https://codedraken.github.io/react-ipsum/).

## NPM

`npm i react-ipsum`

https://www.npmjs.com/package/react-ipsum

## Contributing Instructions

1. Fork the repo and download / clone your fork.

2. Make a new branch name it something like `add-{ComponentName}`

3. Run `npm install`

4. Make your changes following the [Standard JS style](https://standardjs.com/) ( run `npm run lint` and `npm run lint-fix` if you don't want to install Standard )

5. Make sure all tests pass and there are no issues when you run: `npm test` and `npm run lint`

### Commands

`npm run storybook` - starts storybook on `localhost:6006` This is the main way to preview the components. You make a component, add stories for it, and play around with it.

`npm test` - runs unit tests using Jest

`npm run lint` - runs the Standard JS linter

`npm run lint-fix` - runs Standard and tries to fix detected issues

`npm run build` - outputs minified, processed code into `dist/index.js` Use this to test the components like you would if you had installed the package from npm. i.e `import { LoremText } from 'dist'`

`storybook-deploy` - deploys storybook to gh-pages branch.