Skip to content

Commit

Permalink
fix: added the watch to the script and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexandrshy committed Jun 15, 2020
1 parent 8cdd513 commit 0830f2d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.idea/
node_modules/
node_modules/
./example
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,13 @@ Keukenhof.init();
* Add optional focus control inside the modal window
* Add support for CSS animations
* Add accessibility support
* Add a dev server for local development
* Write documentation
* ~~Add a dev server for local development~~

## Contribute

The current build doesn't contain a dev server, but you can run `build` script to build the library and check for changes

```
git clone git@github.com:Alexandrshy/keukenhof.git
cd keukenhof
yarn
```
1. Clone the repository `git@github.com:Alexandrshy/keukenhof.git`
2. Go to the project directory `cd keukenhof`
3. Install dependencies `yarn`
4. Run dev build with auto rebuild after any changes `yarn build:dev`
5. Complete your improvements, commit changes and submit your pull request for review code
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"build": "npm run build:clean && npm run build:lib",
"build:clean": "rimraf dist",
"build:lib": "rollup --config config/rollup/rollup.config.lib.js",
"build:dev": "rollup --config config/rollup/rollup.config.dev.js",
"build:dev": "rollup --config config/rollup/rollup.config.dev.js -w",
"finish": "npm run lint && npm run types"
},
"devDependencies": {
Expand Down

0 comments on commit 0830f2d

Please sign in to comment.