bootstrap4-webpack-boilerplate

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #golang #rust #deep-learning #linux #macos #awesome #awesome-list #security #ios #open-source

bootstrap4-webpack-boilerplate

(★ 39)

A basic boilerplate using Bootstrap 4 with SCSS and WebPack

bootstrap4-webpack-boilerplate Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bootstrap 4 + WebPack 4 = Boilerplate

> [!WARNING]  
> This repository is archived and not maintained anymore!

This is a professional front-end template for building web apps and sites faster, without having to create the basic setup on your own, every time you start a new project.

The template is based on [Bootstrap Framework](https://getbootstrap.com/docs/4.6/) version 4 and uses [Webpack](https://webpack.js.org/) as a flexible and modern module bundler. All common features for front-end projects (like SCSS compilation, minifying of Assets, etc.) are included out of the box.

In addition to the basic front-end project setup, I added some cool features like a configurable image resizing command to make generating responsive images a breeze.

## 1. Features

- [Webpack](https://webpack.js.org) is used as a modern JavaScript module bundler.
- [Babel](https://babeljs.io/) lets you write ES6 compatible JavaScript code.
- [Autoprefixer](https://autoprefixer.github.io/) cares about vendor prefixes in CSS.
- [Responsive images](#responsive-image-generation) have never been easier.

## 2. Quick Start

1. Clone the repository into a new folder for your new project.

```bash
   git clone git@github.com:noreading/bootstrap4-webpack-boilerplate.git my-project
   ```
2. Remove the .git directory to add your own CVS later.

```bash
   rm -rf .git
   ```

3. Update the package.json.

```JSON
      {
        "name": "my-project",
        "description": "A description of my new project",
        "author": "Your Name",
        "license": "MIT"
      }
   ```

4. Install needed dependencies

```bash
   npm install
   ```

5. Run the dev command

```bash
   npm run dev
   ```

The dev command will start Webpack and tell it to watch for changes in JS and SCSS files, to recompile the needed assets.

## 3. Build for production

```bash
npm run build
```

This command tells webpack to run in production mode and compiles all of the assets in a minified version, to deliver smaller files for your users.

## 4. Remove Bootstrap's JavaScript and jQuery

If you **do not** want to use any of the Bootstrap features that are relying on JavaScript and jQuery, you can remove some lines in your code to get rid of them completely.

Remove the following lines of code and re-run the dev command to update the generate assets.

**/src/index.js**

```javascript
import Popper from "popper.js";
window.jQuery = $;
window.$ = $;

require("bootstrap");
```

**/webpack.config.js**

```javascript
new webpack.ProvidePlugin({
  $: "jquery",
  jQuery: "jquery"
});
```

## 5. Environment Configurations

If you use sensitive information in your code, like API keys or encryption tokens, you should never store those in your code repository. This can could lead to a security issue, especially if the repository is public.

Therefore I included the [dotenv-webpack](https://github.com/mrsteele/dotenv-webpack) plugin in this boilerplate, that enables you to store all your sensitive information in a `.env` file, that is ignored by git.

The `.env.default` file should contain all the variables that your application needs, but without the real data and should contain either empty variables or default values that can be used by everyone. The variables will get replaced during asset compilation so that only those variables are added, that are referenced in your code.

It is a common scheme to use an uppercase syntax for environment variables, as you can see in the example below. Comments inside of .env files start with a hash.

```
# GOOGLE APIs

GOOGLE_MAPS_API_KEY=vEVmihkWZ2fqedyHQT***************
YOUTUBE_API_KEY=TnJ8YOfVuL9bbFH83T13N****************

# CACHING
CACHE_ENABLED=false
CACHE_TIMEOUT=3600
```

You can test the usage of environment variables by editing the `.envt` file and changing the value of `HELLO`. After re-compiling the assets you should see a message in the developer console, as soon as you visit the demo page.

**Important:**

After each change of the `.env` file you need to reload Webpack, as the environment is only loaded once per runtime. If you've got an active `npm run dev` command, you need to stop and re-run it, for the changes to take effect.

## 6. Responsive Image Generation

### 6.1 What is it?

This boilerplate includes a command to resize images based on a configuration file, to get rid of the hassle to care about the responsive image sizes manually. One of the benefits of this process is that it works on all major operating systems, without the need to do any manual installations.

If you want to use the resizing feature, please edit the file `images.config.js` in the root directory and change all settings to your needs. You can add multiple collections with different configurations for greatest flexibility.

In order for this command to work properly you need to have "clean" filenames for your images, that don't match the patterns used to create the resized filenames automatically. The filenames get a postfix, based on the resizing settings for the images width and height.

Filenames, that will be recognized as original images, are as follows.

<table>
  <thead>
    <tr>
      <th align="left">Allowed Filename</th>
      <th align="left">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">my-image.jpg</td>
      <td valign="top">Simple filenames</td>
    </tr>
    <tr>
      <td valign="top">my-image-1982-to-2018.jpg</td>
      <td valign="top">Filenames including numbers, also at the end.</td>
    </tr>
    <tr>
      <td valign="top">my-image-400x200-tablet.jpg</td>
      <td valign="top">Filenames including dimensions, but not at the end.</td>
    </tr>
    <tr>
      <td valign="top">my-image_400x200.jpg</td>
      <td valign="top">Filenames including dimensions, but using an underscore.</td>
    </tr>
  </tbody>
</table>

Filenames, that will **not** be recognized as original images, are as follows.

<table>
  <thead>
    <tr>
      <th align="left">Prohibited Filename</th>
      <th align="left">Description</th>
      <th align="left">Pattern</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">your-image-w200.jpg</td>
      <td valign="top">Resized using a fixed width only</td>
      <td valign="top">{filename}-w{width}.{extension}</td>
    </tr>
    <tr>
      <td valign="top">your-image-h400.jpg</td>
      <td valign="top">Resized using a fixed height only</td>
      <td valign="top">{filename}-h{height}.{extension}</td>
    </tr>
    <tr>
      <td valign="top">your-image-200x400.jpg</td>
      <td valign="top">Resized using a fixed width and height</td>
      <td valgin="top">{filename}-{width}x{height}.{extension}</td>
    </tr>
  </tbody>
</table>

You can use a [test tool](https://regex101.com/r/6f2cEu/4) to check if your filenames will work correctly, by adding one filename per line into the "Test Strings" field. This helps to ensure that none of your images will be deleted.

You can use the regular expression to test files on your local machine, too. On Linux and Mac operating systems you can check if any image in a folder would conflict with the resizing tool by using the following command:

```bash
find ./ | grep -E ".*\-([0-9]+x[0-9]+|w[0-9]+|h[0-9]+)\.[a-z]+$"
```

All files that are listed should get renamed, following the rules you can see in the tables above.

---

### 6.2 The Configuration

The responsive image configuration is saved in the `images.config.js` file, located in the root directory of the project.

#### 6.2.1 Global Settings

The configuration has some global settings, that you should set to your personal preferences.

<table>
  <thead>
    <tr>
      <th align="left">Option</th>
      <th align="left">Description</th>
      <th align="left">Default</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">useTrash</td>
      <td valign="top">Moves files to the trash instead of deleting them directly, when using the "recreate" or "remove" argument.</td>
      <td valign="top">false</td>
    </tr>
  </tbody>
</table>

#### 6.2.2 Collections

The configuration uses **collections** which include a set of configuration options to resize images. This allows you to define different resizing rules for multiple directories.

Each collection has the following options.

<table>
  <thead>
    <tr>
      <th align="left">Option</th>
      <th align="left">Description</th>
      <th align="left">Required</th>
      <th align="left">Default</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">name</td>
      <td valign="top">The name of the collection, to identify it in error messages, etc.</td>
      <td valign="top">yes</td>
      <td valign="top">-</td>
    </tr>
    <tr>
      <td valign="top">source</td>
      <td valign="top">The source directory of the image files that should get resized.</td>
      <td valign="top">yes</td>
      <td valign="top">-</td>
    </tr>
    <tr>
      <td valign="top">recursive</td>
      <td valign="top">Resize images in subdirectories, too?</td>
      <td valign="top">no</td>
      <td valign="top">true</td>
    </tr>
    <tr>
      <td valign="top">sizes</td>
      <td valign="top">The configurations for image sizes that get created.</td>
      <td valign="top">yes</td>
      <td valign="top">-</td>
    </tr>
  </tbody>
</table>

#### 6.2.3 Sizes

Each collection has the option "sizes" which includes a set of configurations for different image sizes that will be generated. Width and height are optional, if at least one of them is set.

Each size has the following options.

<table>
  <thead>
    <tr>
      <th align="left">Option</th>
      <th align="left">Type</th>
      <th align="left">Description</th>
      <th align="left">Required</th>
      <th align="left">Default</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">name</td>
      <td valign="top">{string}</td>
      <td valign="top">The name of the collection, to identify it in error messages, etc.</td>
      <td valign="top">yes</td>
      <td valign="top">-</td>
    </tr>
    <tr>
      <td valign="top">width</td>
      <td valign="top">{number}</td>
      <td valign="top">The width of the resized image.</td>
      <td valign="top">no</td>
      <td valign="top">-</td>
    </tr>
    <tr>
      <td valign="top">height</td>
      <td valign="top">{number}</td>
      <td valign="top">The height of the resized image.</td>
      <td valign="top">no</td>
      <td valign="top">-</td>
    </tr>
    <tr>
      <td valign="top">fit</td>
      <td valign="top">{string}</td>
      <td valign="top">The method by which the image should fit.<br /><br />
        <code>cover</code><br />Crop to cover both provided dimensions.<br /><br /><code>contain</code><br>Embed within both provided dimensions.<br /><br /><code>file</code><br />Ignore the aspect ratio of the input and stretch to both provided dimensions.<br /><br /><code>inside</code><br />Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.<br /><br /><code>outside</code><br />Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified.
      </td>
      <td valign="top">no</td>
      <td valign="top">cover</td>
    </tr>
    <tr>
      <td valign="top">position</td>
      <td valign="top">{string}</td>
      <td valign="top">The position When using a fit of "cover" or "contain"<br /><br /><code>left</code>, <code>right</code>, <code>top</code>, <code>bottom</code>, <code>center</code>, <code>left top</code>, <code>right top</code>, <code>left bottom</code>, <code>right bottom</code></td>
      <td valign="top">no</td>
      <td valign="top">center</td>
    </tr>
  </tbody>
</table>

---

### 6.3 The Command Line Arguments

The resizing command supports different arguments to remove resized images, recreate all images, etc.

<table>
  <thead>
    <tr>
      <th align="left">Command</th>
      <th align="left">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">npm run images</td>
      <td valign="top">Creates all resized versions of a file that are missing.</td>
    </tr>
    <tr>
      <td valign="top">npm run images recreate</td>
      <td valign="top">Removes the resized versions of all files and recreates them.</td>
    </tr>
    <tr>
      <td valign="top">npm run remove</td>
      <td valign="top">Removes the resized versions of all files.</td>
    </tr>
  </tbody>
</table>

**Important:**

The recreation and removal arguments will force the command to remove all images it detects as being resized versions (by their filename). If you use other tools for your images that add postfixes to the filenames, this might lead to false positives, so please backup your files before you run this.

```bash
npm run images remove
```

---

## 7. Placeholder Images

All placeholder images used in the `index.html` file are downloaded from [pexels.com](https://www.pexels.com/), and [pixabay.com](https://pixabay.com/). Those are two fantastic collections of free stock photos from photographers around the globe.

If you're one of the photographers and would like to change the linked website or get an image removed from the boilerplate, please shoot me an email to code@dominik-hanke.de and I'll update it as soon as possible.

<table>
  <thead>
    <tr>
      <th align="left">Carousel Image</th>
      <th align="left">Photographer</th>
      <th align="left">Website</th>
      <th align="left">Image Source</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td valign="top">1</td>
      <td valign="top">
        <a href="https://www.pexels.com/@kailash-kumar-212268">kailash kumar</a>
      </td>
      <td valign="top">
        <a href="https://www.facebook.com/kailashkumarphotogrphy/">facebook page</a>
      </td>
      <td valign="top">
        <a href="https://www.pexels.com/photo/white-sheep-on-farm-693776/">pexels.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">2</td>
      <td valign="top">
        <a href="https://pixabay.com/en/users/Cleverpix-2508959/">Cleverpix</a>
      </td>
      <td valign="top">
        <a href="https://www.cleverpix.com.au/">cleverpix.com.au</a>
      </td>
      <td valign="top">
        <a href="https://pixabay.com/en/sunset-tree-water-silhouette-1373171/">pixabay.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">3</td>
      <td valign="top">
        <a href="https://pixabay.com/en/users/GregMontani-1014946/">GregMontani</a>
      </td>
      <td valign="top">
        -
      </td>
      <td valign="top">
        <a href="https://pixabay.com/en/desert-morocco-dunes-sand-2435404/">pixabay.com</a>
      </td>
    </tr>
  </tbody>
</table>

<br />

<table>
  <thead>
    <th align="left">Album Photo</th>
    <th align="left">Photographer</th>
    <th align="left">Website</th>
    <th align="left">Image Source</th>
  </thead>
  <tbody>
    <tr>
      <td valign="top">1</td>
      <td valign="top">
        <a href="https://pixabay.com/en/users/skeeze-272447/">skeeze</a>
      </td>
      <td valign="top">
        -
      </td>
      <td valign="top">
        <a href="https://pixabay.com/en/landscape-panorama-scenic-clouds-2278315/">pixabay.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">2</td>
      <td valign="top">
        <a href="https://www.pexels.com/@shottrotter">shottrotter</a>
      </td>
      <td valign="top">
        <a href="http://www.shottrotter.be/">shottrotter.be</a>
      </td>
      <td valign="top">
        <a href="https://www.pexels.com/photo/photo-of-person-walking-on-deserted-island-934718/">pexels.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">3</td>
      <td valign="top">
        <a href="https://pixabay.com/en/users/sasint-3639875/">sasint</a>
      </td>
      <td valign="top">
        <a href="http://www.pixartasia.com/">pixartasia.com</a>
      </td>
      <td valign="top">
        <a href="https://pixabay.com/en/elephant-animals-asia-large-1822636/">pixabay.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">4</td>
      <td valign="top">
        <a href="https://pixabay.com/en/users/Walkerssk-1409366/">Walkerssk</a>
      </td>
      <td valign="top">
        <a href="http://www.walkers.sk/">walkers.sk</a>
      </td>
      <td valign="top">
        <a href="https://pixabay.com/en/cinque-terre-italy-houses-color-1859688/">pixabay.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">5</td>
      <td valign="top">
        <a href="https://pixabay.com/en/users/Marcocarli-4847725/">Marcocarli</a>
      </td>
      <td valign="top">
        -
      </td>
      <td valign="top">
        <a href="https://pixabay.com/en/mountain-alpine-wild-emperor-2444712/">pixabay.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">6</td>
      <td valign="top">
        <a href="https://www.pexels.com/@jaymantri">Jaymantri</a>
      </td>
      <td valign="top">
        <a href="https://jaymantri.com/">jaymantri.com</a>
      </td>
      <td valign="top">
        <a href="https://www.pexels.com/photo/nature-forest-trees-fog-4827/">pexels.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">7</td>
      <td valign="top">
        <a href="https://www.pexels.com/@veeterzy">veeterzy</a>
      </td>
      <td valign="top">
        <a href="https://www.instagram.com/veeterzy?ref=pexels">instagram profile</a>
      </td>
      <td valign="top">
        <a href="https://www.pexels.com/photo/road-landscape-nature-forest-39811">pexels.com</a>
      </td>
    </tr>
    <tr>
      <td valign="top">8</td>
      <td valign="top">
        <a href="https://www.pexels.com/@pok-rie-33563">Pok Rie</a>
      </td>
      <td valign="top">
        -
      </td>
      <td valign="top">
        <a href="https://www.pexels.com/photo/brown-wooden-footbridge-on-body-of-water-during-sunrise-129441/">pexels.com</a>
      </td>
    </tr>
  </tbody>
</table>

bootstrap4-webpack-boilerplate

bootstrap4-webpack-boilerplate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bootstrap4-webpack-boilerplate

bootstrap4-webpack-boilerplate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README