https://github.com/flaskbb/flaskbb-theme-aurora-mod

Modified Aurora Theme
https://github.com/flaskbb/flaskbb-theme-aurora-mod

Last synced: 3 months ago
JSON representation

Modified Aurora Theme

• Host: GitHub
• URL: https://github.com/flaskbb/flaskbb-theme-aurora-mod
• Owner: flaskbb
• Created: 2016-09-12T20:21:01.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T05:17:58.000Z (over 3 years ago)
• Last Synced: 2025-10-24T18:57:50.455Z (8 months ago)
• Language: HTML
• Size: 2.07 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# INSTALLATION

Clone it into your ``themes/`` folder and save it as ``aurora_mod``.

For example, in FlaskBB's ``themes/`` folder, execute this command:

```bash

git clone https://github.com/sh4nks/flaskbb-theme-aurora-mod aurora_mod

```

# DEVELOPMENT

Make sure that you have npm (nodejs) installed. You can get it from [

here](https://nodejs.org).

This theme uses SASS (https://sass-lang.com/), a CSS preprocessor, for better development.

Before you can compile the source, you need to get a few dependencies first.

This can be achieved by running ``npm install`` in the directory where **this** README is located.

# TASKS

To minimize the dependencies to build and minify our source files, we just use

npm for it.

    Usage

      npm run [TASK]

    Available tasks

      clean

        rm -f node_modules

      autoprefixer

        postcss -u autoprefixer -r static/css/*

      scss

        ./tools/build_css

      uglify

        ./tools/build_js

      imagemin

        imagemin src/img/* -o static/img

      fonts

        ./tools/build_fonts

      build:css

        npm run scss && npm run autoprefixer

      build:js

        npm run uglify

      build:images

        npm run imagemin && npm run fonts

      build:all

        npm run build:css && npm run build:js && npm run build:images

      watch:css

        onchange 'src/scss' -- npm run build:css

      watch:js

        onchange 'src/js' -- npm run build:js

      watch:all

        npm-run-all -p watch:css watch:js

To watch for changes in our JS and SCSS files, you just have to run:

``npm run watch:all``

and upon changes it will automatically rebuild the files.

# CREATING YOUR OWN THEME

See the [theming documentation](https://flaskbb.readthedocs.io/en/latest/theming.html).