This is a simple workflow to start new projects, focused in performance.
This is a simple workflow to start new projects, focused in performance.
You will need to install NodeJS.
# Clone the repository:
$ git clone --recursive [email protected]:leonardofaria/frontend-boilerplate.git
$ cd frontend-boilerplate
# Installs all the dependencies:
$ npm install && npm start
# Starts a local server on port 3000:
$ gulp
The style structure is initially divided into:
@import "variables";
@import "bootstrap";
@import "mixins";
You probably don't need to use the complete Bootstrap version. The bootstrap.scss
file specifies which files to import. Here is what is imported:
_variables.scss
: variables used by Bootstrap to setup HTML styling_mixins.scss
: mixins that are used by other files_normalize.scss
: Nicolas Gallagher's normalize.css
_reboot.scss
: global reset and additional rules on top of normalize.css_grid.scss
: flexbox grid
_utilities.scss
: utilities classesThe mixins.scss
contains an image-replacement mixin.
gulp serve
: start local servergulp css
: compile sass, auto-prefix, write sourcemap, minify CSSgulp lint:css
: lint css according to .stylelintrc
filegulp js
: concat and minify JSgulp deploy:github
: create a gh-pages branch with public
directory contentgulp rsync
: sync the public
directory content via SSHgulpfile.js
in a ES6 format (or replace to NPM scripts)Once you've made your great commits:
(The MIT License)
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.