So you're interested in giving us a hand? That's awesome! We've put together some brief guidelines that should help you get started quickly and easily.
Please, if you see anything wrong you can fix/improve it 👻
- Fork this project on github
- Clone this project on your local
- Then, you need to install
nodeandnpmto run the mainly packages. - After installed
nodeandnpm, run this script:
$ npm installThat's it! You're done.
We are using a bunch of things to put all togethe and make the work easy.
| Dependency | Description |
|---|---|
| NPM | Node package manager |
| Gulp | Run some tasks (bundle, server, etc) |
| BrowserSync | Create a localhost server with livereload |
| Webpack | Generated a UMD bundled version |
| Jest | Run the tests |
So, have some scripts that you need to know to run the project locally. It's just fews, but it's very important.
| Command | Description |
|---|---|
npm run bundle |
Make the entire bundle with Gulp (compressed and uncompreed version) |
npm start |
Run $ gulp default task |
npm test |
Run all tests with Jest |
gulp |
Default task that runs gulp webpack, gulp server and gulp watch |
gulp webpack |
Run the Webpack bundle |
gulp webpack --production |
Run the Webpack production version bundle |
gulp server |
Run the BrowserSync server |
gulp watch |
Watch when the lib files change |
- Create your feature branch: git checkout -b my-new-feature
- Commit your changes: git commit -m 'Add some feature'
- Push to the branch: git push origin my-new-feature
- Make sure that all bundles are passing in TravisCI
- Submit a pull request :D