README.md

Starter Kit

A simple and powerful Starter Kit made with Webpack, Gulp 4, Pug and SASS

Table of Contents

• Installation
• Support
• Contributing
• Tasks
• History
• License

Installation

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 for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request. 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 for detailed changelog.

Author

Fernando Moreira

License

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Code is under MIT 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