Getting Started

Introduction

Hello, I hope you find this template useful. Spark has been crafted on top of Bootstrap 5. The included docs don't replace the official ones, but provide a clear view of all extended styles and new components that this template provides on top of Bootstrap 5.

The docs includes information to understand how the theme is organized, how to make changes to the source code, and how to compile and extend it to fit your needs.

Thanks, and good luck!

Quick start

The theme includes a custom Webpack file, which can be used to quickly recompile and minify theme assets while developing or for deployment. You'll need to install Node.js before using Webpack.

Once Node.js is installed, run npm install to install the rest of Spark's dependencies. All dependencies will be downloaded to the node_modules directory.

npm install

Now you're ready to modify the source files and generate new dist/ files. Spark is using webpack and webpack-dev-server to automatically detect file changes and start a local webserver at http://localhost:8080.

npm start
Build tools

Start a local webserver at http://localhost:8080 and detect file changes:

npm start

Automatically detect file changes without starting a local webserver:

npm run watch

Compile, optimize, minify and uglify all source files to dist/:

npm run build
Contents

Inside the zip-file you'll find the following directories and files. Both compiled and minified distrubution files, as well as the source files are included in the package.

theme/
  ├── .babelrc
  ├── .gitignore
  ├── package.json
  ├── postcss.config.js
  ├── webpack.config.js
  ├── README.md
  ├── docs/
  ├── src/
  │   ├── css/
  │   │   ├── mixins/
  │   │   ├── utilities/
  │   │   └── app.scss
  │   ├── js/
  │   │   ├── modules/
  │   │   ├── vendor/
  │   │   └── app.js
  │   │── fonts/
  │   └── img/
  └── dist/
      ├── css/
      │   └── app.css
      ├── js/
      │   └── app.js
      ├── img/
      └── fonts/
Basic Template & Theming

This basic template can be used as a guideline for how to structure new pages while using Spark. Some meta tags and our CSS & JS files are included inside the template.

The following themes are available:

  • modern
  • classic
  • light
  • dark
<!DOCTYPE html>
<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, shrink-to-fit=no">
  <meta name="description" content="">
  <meta name="author" content="">

  <title>Spark</title>

  <link href="{PATH}/dist/css/{THEME}.css" rel="stylesheet">
</head>
<body>
  <h1>Hello, world!</h1>

  <script src="{PATH}/dist/js/app.js"></script>
</body>
</html>