@chillerperser/frontguide v0.1.4

Frontguide

Easy styleguide.

Configuration

• Create a file named frontguide.json in the root folder.
• Every option is optional.

Example:

{
    "title": "Browsertitle",
    "assets_path": "./public",
    "server": {
        "port": 3000
    },
    "navigation": {
        "logo": "SVG file content"
    },
    "components": {
        "source": "./app/components/**/*.njk",
        "layout": "./app/components/layout.njk",
        "badges": [
            {
                "key": "todo",
                "background": "#ff0000",
                "color": "#fff",
                "title": "In Arbeit"
            },
            {
                "key": "done",
                "background": "green",
                "color": "#fff",
                "title": "Fertig"
            }
        ]
    }
}

title

Set the browser title.

assets_path

Path where your assets file are, like JS/CSS files.

server

port

Set the dev server port (default: 3000)

navigation

logo

Add a logo to the navigation. Should be an SVG as string

components

source

Path to your components.

layout

Path to your layout file. Which should include the basic structure of your website/app.

badges

Create a set of badges. These can be used on each component with the given key.

Development

• SASS/JS watcher npm run watch
• DEV Server npm run server

Production

• Run npm run build

3rd Party

• Using icons from https://tabler-icons.io/