Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,14 @@
# Front-end Boilerplate using Sass and Gulp 4

Using a set of boilerplate files when you're starting a website project can be a huge time-saver. Instead of having to start from scratch or copy and paste from previous projects, you can get up and running in just a minute or two.

I wanted to share my own boilerplate that I use for simple front-end websites that use HTML, SCSS, and JavaScript. And I'm using Gulp 4 to compile, prefix, and minify my files.

I also wrote a rather detailed walkthrough on how to get up and running with Gulp 4, as well as migration tips from Gulp 3.

You can read that on my blog [here](https://coder-coder.com/gulp-4-walk-through).

## Quickstart guide
# Quickstart guide

* Clone or download this Git repo onto your computer.
* Install [Node.js](https://nodejs.org/en/) if you don't have it yet.
* Run `npm install`
* Run `gulp` to run the default Gulp task

In this proejct, Gulp is configured to run the following functions:
In this project, Gulp is configured to run the following functions:

* Compile the SCSS files to CSS
* Autoprefix and minify the CSS file
* Concatenate the JS files
* Uglify the JS files
* Move final CSS and JS files to the `/dist` folder

60 changes: 10 additions & 50 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,52 +1,12 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<!-- General meta tags needed-->
<meta charset="utf-8">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<!-- Needed for responsive design -->
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- If you want custom browser colors on mobile -->
<meta name="theme-color" content="#1843c1" />
<meta name="apple-mobile-web-app-status-bar-style" content="#1843c1">

<title></title>

<!-- Google Fonts -->
<link href="https://fonts.googleapis.com/css?family=Roboto:400,700" rel="stylesheet">

<!-- CSS File -->
<link rel="stylesheet" href="dist/style.css?cb=1572492103778">
</head>
<body>

<main>
<section class="content">
<h1>Front-end Boilerplate</h1>
<h2>Using Sass and Gulp</h2>

<p>
Here's a quick set-up guide:
</p>

<ul>
<li>Clone Git repo</li>
<li>Install by running "npm install" on the commmand line</li>
<li>Run "gulp" on the command line.</li>
</ul>

</section>

<aside>
<h3>Project Info</h3>
<p>
This is a starter front-end project which will compile SCSS and JS files using Gulp 4.
</p>
</aside>

</main>

<!-- JavaScript File -->
<script src="dist/all.js?cb=1572492103778"></script>
</body>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<h1>hell world</h1>
</body>
</html>
Loading