https://github.com/onedevstudio/starter-kit
🏃 A simple and powerful Starter Kit made with Webpack, Gulp 4, Pug and SASS
https://github.com/onedevstudio/starter-kit
babel boilerplate es6 eslint gulp gulp4 postcss sass starter starter-kit stylelint webpack
Last synced: about 1 year ago
JSON representation
🏃 A simple and powerful Starter Kit made with Webpack, Gulp 4, Pug and SASS
- Host: GitHub
- URL: https://github.com/onedevstudio/starter-kit
- Owner: onedevstudio
- License: mit
- Created: 2017-10-31T11:21:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-26T14:20:42.000Z (almost 7 years ago)
- Last Synced: 2025-04-09T10:12:18.020Z (about 1 year ago)
- Topics: babel, boilerplate, es6, eslint, gulp, gulp4, postcss, sass, starter, starter-kit, stylelint, webpack
- Language: JavaScript
- Homepage: https://starter-kit.nandomoreira.dev/
- Size: 701 KB
- Stars: 21
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Starter Kit](https://starter-kit.nandomoreira.dev/)
[](https://codeclimate.com/github/onedevstudio/starter-kit/maintainability)    [](https://app.netlify.com/sites/starter-kit/deploys)
> A simple and powerful Starter Kit made with Webpack, Gulp 4, Pug and SASS
## Table of Contents
- [Installation](#installation)
- [Support](#support)
- [Contributing](#contributing)
- [Tasks](#tasks)
- [History](#history)
- [License](#license)
## Installation
```bash
git clone https://github.com/onedevstudio/starter-kit.git your-project
cd your-project/ && rm -rf .git
yarn install # or npm install
yarn dev # or npm run dev
```
## Support
Please [open an issue](../../issues/new) for support.
## Contributing
Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](../../compare?expand=1).
Contributing
1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D
## Tasks
**Gulp tasks**
- `gulp` ~> Build and watch files
- `gulp watch` ~> Watch js files
- `gulp server` ~> Watch js files and start browser sync server
- `gulp copyFiles` ~> Copy static files
- `gulp favicons` ~> Generate all favicons
- `gulp build` ~> Build all files
**NPM scripts**
- `npm run start` ~> Starts the task `gulp server` in env production
- `npm run prod` ~> Starts the tasks `npm run lint` and `npm run build`
- `npm run build` ~> Starts the tasks `gulp build` in env production
- `npm run dev` ~> Starts the tasks `gulp` in env development
- `npm run deploy` ~> Starts the tasks `npm run prod` and run the command `netlify deploy --prod`
- `npm run eslint` ~> Run the command `eslint .`
- `npm run eslint:fix` ~> Run the task `npm run eslint --fix`
- `npm run stylelint` ~> Run the command `stylelint "**/*.scss"`
- `npm run stylelint:fix` ~> Run the task `npm run stylelint --fix`
- `npm run lint` ~> Starts the tasks `npm run eslint` and `npm run stylelint`
- `npm run pre-commit` ~> Start the task `npm run lint`
## History
See [Releases](../../releases) for detailed changelog.
## Author
| [](http://twitter.com/oseunando "Follow @oseunando on Twitter") |
| ----------------------------------------------------------------------------------------------------------------------------------------------- |
| [Fernando Moreira](http://twitter.com/oseunando) |
## License
```
WWWWWW||WWWWWW
W W W||W W W
||
( OO )__________
/ | \
/o o| MIT \
\___/||_||__||_|| *
|| || || ||
_||_|| _||_||
(__|__|(__|__|
```
Code is under [MIT License](/LICENSE) - © Fernando Moreira
## Buy me a coffee?
It will encourage me to keep it going, fix whatever bugs you find and spend time making it better :D
