https://github.com/michalsnik/js-plugin-starter
Simple JS plugin starter repository
https://github.com/michalsnik/js-plugin-starter
Last synced: 2 months ago
JSON representation
Simple JS plugin starter repository
- Host: GitHub
- URL: https://github.com/michalsnik/js-plugin-starter
- Owner: michalsnik
- License: mit
- Created: 2015-11-11T09:17:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-11T10:09:16.000Z (over 9 years ago)
- Last Synced: 2024-10-28T16:37:27.266Z (7 months ago)
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# js-plugin-starter
Simple JS plugin starter repository
With all necessary configuration to bootstrap your ideas and get rid of setting everything all over again.
## Instruction
1. Clone Repository
```bash
git clone [email protected]:michalsnik/js-plugin-starter.git your-plugin-name
```
2. Go to your-plugin name folder and install npm packages
```bash
cd your-plugin-name && npm install
```
3. If you change ```plugin.js``` or ```plugin.scss``` name remember to change it inside ```plugin.json``` file as well.
Gulp tasks relies on those names in order to do its job correctly.
4. Run gulp
```bash
gulp
```
5. Go to ```http://localhost:3000/demo/``` and now you're ready to roll
### Additional info
Starter uses browserify for bundling JS, so don't hesitate to require node modules and partition your code to make it more pleasant to work with.