JavaScript HTML Other
Clone or download
Latest commit ca0376b Jul 15, 2018

README.md

BootstrapCDN

Linux Build Status Windows Build status Coverage Status dependencies Status devDependencies Status

Follow BootstrapCDN on Twitter Backers on Open Collective Sponsors on Open Collective

Deploy your own copy on Heroku

Deploy to Heroku

Requirements

  1. Node.js

Running

Use npm run <task>.

Development

npm install

npm test && npm run dev

Demonized

# start development server and watch for changes
npm run dev
# or
npm run watch

# start production server
npm start

# and more
npm run

Configuration

config/_app.yml

The Express.js app configuration.

  • port: Integer value of the Node application port.
  • theme: Integer value of the default theme we use; it's the array index value from the bootswatch4 section below.
  • siteurl: Our canonical URL.
  • authors: Array of author Objects. Accepts the following:
    • name
    • twitter: the Twitter handler without @
    • url: author's website URL (optional)
    • work: (optional) Object which can contain:
      • text: the text to show for the url bellow
      • url: the link to the work
  • description: String containing the default meta description of the site.
  • favicon: The path to favicon.ico.
  • stylesheet: Array of stylesheet file(s) we use apart from the Bootswatch stylesheet.
  • javascript: Array of javascript file(s) we use.
  • redirects: Array of Objects for the page redirects.

config/_extras.yml

Contains the /showcase/ and /integrations/ config we use in the Express.js app.

config/_files.yml

Contains the CDN files we host.The SRI values are updated by running npm run integrity.

config/helmet-csp.js

Our CSP config using https://github.com/helmetjs/csp

Updating Bootstrap/Bootlint/Bootswatch

Replace package by the package you want to update and version with its version in the following commands:

npm i package@version --save-exact -D
npm run package version
  1. Update config/_config.yml accordingly
  2. npm run integrity
  3. Make sure npm run all passes after the files are on S3/CDN and verify the frontend works as expected without any visual breakage

Backers

Thank you to all our backers! 🙏 [Become a backer]

Bakers

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]