Skip to content
boilerplate for static website based on webpack, best practices and modern tools
CSS HTML JavaScript Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
Dockerfile
README.md
docker-compose.yml
package-lock.json
package.json

README.md

Bass

Full-featured boilerplate for static website based on webpack, best practices and modern tools.

🚀 Demo

Features

Requirements

OR

Usage

# clone repo
$ git clone https://github.com/verzola/bass.git

# enter in directory
$ cd bass

# run on docker (recommended)
$ docker-compose up -d

# or run locally
$ npm install
$ npm run dev

# other scripts
$ npm run build # builds website to dist folder
$ npm run format # formats code using prettier
$ npm run lint # lint js & scss
$ npm run lint:js # lint js only
$ npm run lint:scss # lint scss only

Pages

To create a page, create a .hbs file in src/pages directory, like src/pages/index.hbs.

You can also create a json file corresponding to the name of the page to inject variables in src/data, like src/data/index.json.

SCSS & JS

There is a default stylesheet in src/scss/main.scss and script in src/js/index.js.

The sass structure is based on sass-boilerplate.

Custom webpack config

You can override the default webpack config by creating a bass.config.js exporting a function that receives the webpack config and returns it back:

module.exports = function(defaultConfig) {
  // do something
  return defaultConfig
}

Contributing

Contribuitions are welcome. If you find any problem or have a suggestion, please open an issue.

Known issues

  • Watch does not work on Docker Desktop on Windows (see)
You can’t perform that action at this time.