Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johndavemanuel/bootstrap-gulp-starter-template
Bootstrap 4 + Gulp 4 + Panini for improve front-end development workflow
https://github.com/johndavemanuel/bootstrap-gulp-starter-template
automation boilerplate bootstrap front-end front-end-development gulp handlebars panini sass starter starter-project template workflow
Last synced: 6 days ago
JSON representation
Bootstrap 4 + Gulp 4 + Panini for improve front-end development workflow
- Host: GitHub
- URL: https://github.com/johndavemanuel/bootstrap-gulp-starter-template
- Owner: johndavemanuel
- License: mit
- Created: 2018-12-27T07:19:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-13T12:27:06.000Z (about 2 years ago)
- Last Synced: 2024-10-31T10:51:37.071Z (13 days ago)
- Topics: automation, boilerplate, bootstrap, front-end, front-end-development, gulp, handlebars, panini, sass, starter, starter-project, template, workflow
- Language: CSS
- Homepage: https://johndavemanuel.github.io/bootstrap-gulp-starter-template
- Size: 3.51 MB
- Stars: 75
- Watchers: 7
- Forks: 25
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BOOTSTRAP + GULP STARTER TEMPLATE
[](#contributors-)
### Note
The `docs` folder is for demo purposes only.
Changes should be commited to `src` files only.
The `dist` folder is not kept in source control.
### How to use
The template is built with Sass and Gulp build system with these features:
- Handlebars HTML templates with Panini – a super simple flat file generator for use with Gulp. It compiles a series of HTML pages using a common layout. These pages can also include HTML partials, external Handlebars helpers, or external data as JSON or YAML.
- Sass compilation, prefixing with autoprefixer, and javaScript concatenation
- Built-in BrowserSync server - will automatically reload your page when files are changed. It also live-injects CSS changes when you save a Sass file. This task runs continuously and defaults to localhost.
- For production builds - CSS compression, JavaScript compression, Image compression and more.
### Requirements
To use this template, your computer needs:
- Node.js is used to run the build processes. https://nodejs.org/en/download/
- Run ` node -v ` in the terminal
- npm (Node comes with npm installed so you should have a version of npm.) Used to manage development dependencies.
- Run ` npm -v` in the terminal
- Gulp – task runner
`npm install -g gulp`
- Run `gulp -v ` in the terminal
### Installing:
- Clone this repo: `git clone https://github.com/johndavemanuel/bootstrap-gulp-starter-template.git`
- Navigate into the repo directory: `cd bootstrap-gulp-starter-template`
- Install all node packages: `npm install`
- Run `gulp development`
- Your site is now viewable at this URL: http://localhost:3000
- To create compressed, production-ready assets run `gulp production`. This will delete everything in the dist folder and recreate all of your complied files. Never make updates directly into the dist folder as these files get overridden each time.
### Folder Structure:
- `dist/` - compiled distribution files
- `node_modules` - front-end dependencies
- `src/` - contains all of your core, working files—static assets, pages, templates, etc
- `src/assets/` - scss files, JS files, images, and fonts
- `src/data/` - external data (JSON or YAML)
- `src/layouts/` - HTML layouts templates
- `src/pages/` - site pages
- `src/partials/` - handlebars partials files.
- `gulpfile.js` - all task definitions
- `package.json` - handles the project dependencies
- `.htmllintrc` - handles the HTML lint rules
- `.sass-lint.yml` - handles the SCSS lint rules
- `reports` - txt generated file for accessibility issues
### Includes:
- [Fontawesome 5](https://fontawesome.com/)
- [Animate CSS](https://animate.style/)
- [RTL Support](https://github.com/tysonmatanich/directional-scss)
### Gulp Plugins:
- [gulp-accessibility](https://www.npmjs.com/package/gulp-accessibility)
- [gulp-autoprefixer](https://www.npmjs.com/package/gulp-autoprefixer)
- [gulp-compile-handlebars](https://www.npmjs.com/package/gulp-compile-handlebars)
- [gulp-concat](https://www.npmjs.com/package/gulp-concat)
- [gulp-cssmin](https://www.npmjs.com/package/gulp-cssmin)
- [gulp-gh-pages](https://www.npmjs.com/package/gulp-gh-pages)
- [gulp-html-replace](https://www.npmjs.com/package/gulp-html-replace)
- [gulp-htmllint](https://www.npmjs.com/package/gulp-htmllint)
- [gulp-imagemin](https://www.npmjs.com/package/gulp-imagemin)
- [gulp-jshint](https://www.npmjs.com/package/gulp-jshint)
- [gulp-newer](https://www.npmjs.com/package/gulp-newer)
- [gulp-pretty-html](https://www.npmjs.com/package/gulp-pretty-html)
- [gulp-purgecss](https://www.npmjs.com/package/gulp-purgecss)
- [gulp-remove-code](https://www.npmjs.com/package/gulp-remove-code)
- [gulp-remove-logging](https://www.npmjs.com/package/gulp-remove-logging)
- [gulp-rename](https://www.npmjs.com/package/gulp-rename)
- [gulp-sass](https://www.npmjs.com/package/gulp-sass)
- [gulp-sass-lint](https://www.npmjs.com/package/gulp-sass-lint)
- [gulp-sourcemaps](https://www.npmjs.com/package/gulp-sourcemaps)
- [gulp-uglify](https://www.npmjs.com/package/gulp-uglify)
- [gulp-babel](https://www.npmjs.com/package/gulp-babel)
### Additional Resources:
- [Sass: Syntactically Awesome Style Sheets](http://sass-lang.com/)
- [Bootstrap](https://getbootstrap.com/)
- [Handlebars](http://handlebarsjs.com/)
- [Panini](https://github.com/zurb/panini)
- [Gulp](https://gulpjs.org/getting-started)
### License
[MIT](LICENSE)
### Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
