https://github.com/willmendesneto/generator-poi-boilerplate-demo

Demo React Component from POI boilerplate generator
https://github.com/willmendesneto/generator-poi-boilerplate-demo

Last synced: about 2 months ago
JSON representation

Demo React Component from POI boilerplate generator

• Host: GitHub
• URL: https://github.com/willmendesneto/generator-poi-boilerplate-demo
• Owner: willmendesneto
• Created: 2017-12-23T13:30:02.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-30T09:23:09.000Z (about 7 years ago)
• Last Synced: 2024-09-16T03:19:24.863Z (4 months ago)
• Language: JavaScript
• Size: 1.05 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# generator-poi-boilerplate-demo 

> Demo React Component from POI boilerplate generator

## Usage

```bash

yarn add generator-poi-boilerplate-demo

# or 

npm install generator-poi-boilerplate-demo

```

For more details, see [`src/js/components/generator-poi-boilerplate-demo.js`](./src/js/components/generator-poi-boilerplate-demo.js)

## Code Architecture

Check out the [`[email protected]`

docs](https://github.com/willmendesneto/generator-poi/tree/v2.1.1#code-architecture)

for info on the repo layout, structure and meaning.

## Publishing the package

This project is using `np` as publisher helper. For more information, please check [`np` documentation](https://github.com/sindresorhus/np#readme)

## NPM Commands

### Component commands

- `npm run start`:  start component page example using [`react-storybook`](https://github.com/storybooks/storybook);

- `npm run watch`:  start component page in watch mode example using [`react-storybook`](https://github.com/storybooks/storybook),

- `npm run demo:deploy`: Publishing your component page in your Github Page

- `npm run build:page`: Creates your page bundle;

- `npm run build:library`: Creates your component bundle to be published in your NPM repository (public or private). This bundle will NOT include [`react-storybook`](https://github.com/storybooks/storybook) and other development dependencies;

- `npm run serve:dist`: Creates a server based on the component page that will be deployed in your Github Page. This command is used to check the results locally before you deploy your component example page;

- `npm run test`: Running unit tests using MochaJS

- `npm run tdd`: Running unit tests using MochaJS in watch mode. It will help you to create a component using [`Test Driven Development` approach](https://en.wikipedia.org/wiki/Test-driven_development)

## Changes and history

See [CHANGELOG.md](./CHANGELOG.md).