Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 1.6 KB

README.md

File metadata and controls

58 lines (45 loc) · 1.6 KB

Front-end Starter Kit

This is my very own extremely opinionated front-end starter kit. I'm just putting it out here in case someone finds it helpful in any way. You’re very welcome to submit issues and contribute if you see anything that needs improvements (I bet there is).

If you would like to see something added to the mix, please feel free to let me know via Twitter: @nichlaswa

Powered by

alt text

Getting Started

Install all dependencies

$ bundle install and $ npm install

Run local development server

Run $ gulp to start the server, a new browser window/tab automatically opens on localhost:3000

Folder structure

The only folder you need to think about is the ./src folder, all your content should go in here. Make sure you follow the folder structure to ensure that all files get processed in the task runner.

front-end-starter-kit/
|
|- src/
|  |- index.html _____________________ # Entry point
|
|  |- scss/
|    |- main.scss ____________________ # Main SCSS file, only imports
|    |- partials/
|       |-  _base.scss________________ # Base styles
|       |-  _variables.scss___________ # Variables
|       |-  ..._______________________ # Add your own components here
|
|  |- images/
|     # Put all your images here, including content images
|
|  |- js/
|    |- main.js ______________________ # Main JS

Based on

  • jekyll
  • gulp
  • browsersync
  • modernizer
  • babel
  • sass
  • postcss
    • nextcss
    • autoprefixer
  • cssnano
  • imagemin
  • uglifyjs