Skip to content

Commit

Permalink
Base Starter V4.1.1
Browse files Browse the repository at this point in the history
- Updated Readme
  • Loading branch information
matthewhartman committed Dec 18, 2018
1 parent a231910 commit a853c57
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 15 deletions.
4 changes: 4 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Base Starter Change Log

## [4.1.1] - 2018-12-18
### Base Starter V4.1.1
- Updated Readme

## [4.1.0] - 2018-12-18
### Base Starter V4.1.0
- Replaced Gulpjs with Webpack
Expand Down
18 changes: 3 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,14 @@ git clone https://github.com/matthewhartman/base-starter.git your-website \

Base starter includes the latest version of Base and Base Modules to get you started.

Base starter has a powerful GulpJS config which compiles SCSS with live reload support, optimises images minifies CSS/JS and can inline CSS/JS code.

The GulpJS file has a series of tasks which are listed below:

| Gulp Task | Purpose |
| --------- | ------- |
| `sass` | Compiles `src/style.scss` into `src/css/style.css` and `/dist/css/style.css` |
| `jsmin` | All JS code located within `/src/js/` is minified and compiled into `dist/` |
| `imagemin` | All images (svg, png, jpg, gif) are optimised and compressed without sacrificing quality by removing metadata and unnecessary color profiles to save bytes and make images load much faster. The optimised images are compiled within `dist/` |
| `browserSync` | Automatically reloads the browser whenever a SCSS or HTML file is saved within `src/` |
| `inlinesource` | A task which embeds all `<script>`, `<link>` and `<img>` code inline within a HTML document. Will only occur to elements which have the inline attribute applied (eg: `<script inline>`). The compiled HTML files with the embedded code are saved within `dist/` |
Base starter has a powerful Webpack config which compiles SCSS with live reload support, optimises images minifies CSS/JS and inlines CSS/JS code.

There are a series of npm scripts that can perform all the above tasks in a single action. Below is a list of all the npm scripts within the Base Starter package.json.

| NPM Task | Outcome |
| -------- | ------- |
| `npm start` | Starts up a server using BrowserSync and watches for all HTML and SCSS changes within `/src` |
| `npm run clean` | Removes `/dist` |
| `npm run build` | The build task runs gulp tasks in the following order: `clean`, `sass`, `imagemin`, `jsmin`, `inlinesource` |
| `npm run dist` | The dist task runs gulp tasks in the following order: `clean`, `sass`, `imagemin`, `jsmin`, `inlinesource` |
| `npm start` | Starts up a web server and watches for HTML, SCSS and JS changes within `/src` |
| `npm run build` | The build task optmises your website for production |

If you would like to learn more about Base and the Base Modules, head over to the [main documentation](https://github.com/getbase/base#documentation).

Expand Down

0 comments on commit a853c57

Please sign in to comment.