Simple front-end boilerplate with everything needed fto develop simple web pages/web apps
- SASS and LESS compiler
- Autoprefixer
- CSS and Javascript concatenation and compression
- Image compression
- Browsersync
- Automatically inject JS, CSS/SASS from bower using Asset Builder
- Ability to manage dependencies in Asset Builder file,
assets/manifest.json
.
├── assets
│ ├── fonts
│ ├── images
│ ├── manifest.json
│ ├── scripts
│ │ └── main.js
│ └── styles
│ ├── base
│ │ ├── _fonts.scss
│ │ ├── _general.scss
│ │ ├── _grid.scss
│ │ └── _media.scss
│ ├── components
│ │ └── _buttons.scss
│ ├── config
│ │ ├── _mixins.scss
│ │ └── _variables.scss
│ ├── layout
│ │ ├── _footer.scss
│ │ ├── _header.scss
│ │ └── _sections.scss
│ ├── main.scss
│ └── pages
├── bower.json
├── gulpfile.js
├── LICENSE
├── package.json
├── public
│ ├── 404.html
│ ├── crossdomain.xml
│ ├── humans.txt
│ ├── index.html
│ ├── robots.txt
│ └── sitemap.xml
├── README.md
Download / Clone repo and CD into the created folder
$ git clone https://github.com/luism-s/myBoilerplate.git projectname
$ cd projectname/
Install Node dependencies
$ npm install
Install Bower dependencies
$ bower install
Copy the .env.example file to a new file and name it .env
$ cp .env.example .env
Open the .env file and change DEV_URL variable value for your own virtualhost URL (ex: mysupernewsite.local)
Run tasks once:
$ gulp
Clean 'public/assets' folder:
$ gulp clean
Watch for changes:
$ gulp watch
Build for production:
$ gulp build
List all gulp commands:
$ gulp -T
This project is influenced by similar projects such as:
The MIT License (MIT)
Copyright (c) 2016 Luís Silva
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
tl;dr: Free as the rain