Diwanee-FE / Diwanee-Boilerplate

3 stars 0 forks source link

Diwanee Boilerplate

SCSS and JS boilerplate for starting new projects

So you got a new project, but the thought of having to figure out how to structure your SCSS files, name your classes and make that pesky slider from scratch is giving you headaches?
Have no fear!
This is where this Boilerplate comes in handy.
All you have to do is follow these easy steps and all your earthly worries will be gone forever!
But wait, there's more!
If you have an idea for a new commonly used element, you can contribute to the effort.

1 - INSTALLATION

Open your terminal and type the following:

Step 1: git clone git@github.com:Diwanee-FE/Diwanee-Boilerplate.git
Step 2: cd Diwanee-Boilerplate
Step 3: Copy the files/folders you need or want into your project folder

2 - DEVELOPMENT

To start development, you need to install the required NPM and Bower components.
To do so, follow these simple steps


Step 1: Open your terminal and type the following
Step 2: git checkout elements
Step 3: npm install
Step 4: bower install
Step 5: gulp
Step 6: Open your browser
Step 7: Go to - localhost:1337

2.1 - When working on a new element:

Step 1: git checkout -b nameOfElement
Step 2: Make awesome code

2.2 - When development on the specific element is done:

3 - KNOWN ISSUES