Skip to content

iStuffs/starter-kit

Repository files navigation

Front-end Starter Kit

A npm / gulp kick start template for fast and modern front-end development.

Featues:

The SASS folder structure:

sass/
├── helpers/
│   ├── _variables.scss
│   ├── _bourbon.scss
│   ├── _functions.scss
│   └── _mixins.scss
├── base/
│   ├── _reset.scss
│   └── _typography.scss
├── components/
│   └── ...
├── layout/
│   ├── _footer.scss
│   ├── _global.scss
│   └── _header.scss
└── style.sass

Sass Documentation : https://istuffs.github.io/starter-kit/

What you need ?

You first need to have node.js installed. You should use git with your project.

How to use

  1. Clone it
git clone https://github.com/iStuffs/starter-kit.git my-new-project
  1. Update your github user in the package.json
...
"gitUser": "Your-GitHubUserName",
...
  1. kickstart your project
cd my-new-project
npm run starter
  1. Develop awesome things
npm start
  1. Build assets for production
npm run build
  1. Deploy on git hub pages
npm run deploy