Skip to content

megumiteam/dc-pattern-lib-v2

Repository files navigation

dc-pattern-lib

Build Status npm package Coveralls

Getting started

$ git clone [email protected]:megumiteam/dc-pattern-lib-v2.git
$ cd dc-pattern-lib-v2
$ npm install
$ npm start

Browser check

npm start will be start to run two local server.

It is a demo site to use the package. All source code are in demo/src directory.

And we can start the server by the following command.

# start all dev server
$ npm start

# start the demo server
$ npm run start-nwb

It is a component catalog made by a Storybook. All source code are in stories/ directory.

And we can start the server by the following command.

# start all dev server
$ npm start

# start the demo server
$ npm run storybook

Contributing

$ git checkout -b YOUR_TOPIC_BRANCH

# edit some code
...

# Lint
$ npm run lint

# Test
$ npm test

# Push your branch
$ git push origin YOUR_TOPIC_BRANCH

# Then, you can make a Pull Request

Publish

We publish it from Travis CI. You should run the following command after merge your TOPIC BRANCH into the master branch.

$ git checkout master
$ git pull origin master
# Tag it ( https://semver.org/ )
$ npm version {major | minor | patch}

After run npm version, the npm run postversion will run to push the tag into GitHub. And Travis CI will start to build and publish it when you push a tagged branch.