Sign in

Bootstrap 3.4.x NES

 

How to configure Bootstrap NES

First, please review our Minimum Requirements to ensure a smooth installation.  Then follow 4 easy steps:

  1. Update your package.json
  2. Create or update your .npmrc file
  3. Configure DOMPurify
  4. Install & Run!

Detailed Instructions

1. Substitute the Bootstrap dependency in your package.json with the following:

{
   "dependencies": {
      "bootstrap": "npm:@neverendingsupport/bootstrap@3.4.5"
   },
   "overrides": {
      "bootstrap": { ".": "npm:@neverendingsupport/bootstrap@3.4.5" }
   }
}


2. Create an .npmrc file with the following:

   - Replace <YOUR_NES_ACCESS_TOKEN> with your access token

@neverendingsupport:registry=https://registry.nes.herodevs.com/npm/pkg/
//registry.nes.herodevs.com/npm/pkg/:_authToken=<YOUR_NES_ACCESS_TOKEN>


3. Configure DOMPurify

DOMPurify is a DOM-only, super-fast, XSS sanitizer for HTML.

HeroDevs strongly recommends that you include DOMPurify as a dependency along with your Bootstrap NES 3.4.5 packages to provide optimal security protection for your application.

Bootstrap NES 3.4.5 and above will automatically detect DOMPurify and utilize it as needed. For this to happen, DOMPurify must be available on the window object. There are various ways to achieve this depending on your setup. 

Option 1

Add the DOMPurify dependency to your package.json with the following:

{
   "dependencies": {
      ... // existing dependencies
      "bootstrap": "npm:@neverendingsupport/bootstrap@3.4.5",
      "dompurify": "^3.1.5",
   },
   "overrides": {
      "bootstrap": { ".": "npm:@neverendingsupport/bootstrap@3.4.5" }
   }
}

Then ensure node_modules/dompurify/dist/purify[.min].js is included in your application, either as a standalone script or in your application bundle.

There are many ways in which dependencies are imported and bundled together in applications. You must ensure that your application makes DOMPurify available on the window object in order for it to work properly. Here is an example of how it could be accomplished within an application that uses Webpack. 

// webpack.config.js

module.exports = {
...

  plugins: [
    ...

    new webpack.ProvidePlugin({
     'window.DOMPurify': 'dompurify',
    }),
  ],

...
};

Option 2

Include DOMPurify from a CDN in your HTML template.

<html lang="en">
 <head>
 <title>Home</title>
 ...
 <script src="https://cdnjs.cloudflare.com/ajax/libs/dompurify/3.1.5/purify.min.js"></script>
 ...

  

4. Install your dependencies: 
npm install

Now you can run your integration tests against Bootstrap NES!

 

Additional Information

The direct download URL for Bootstrap NES is: