mandynicole / brunchline

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Brunch repository was officially archived on June 15, 2023, and so too, this little idea for a starter. Thankfully most, if not all, of the goals in this project can be replicated in 11ty or Astro with a much more modern toolset.

Brunchline

Brunchline once intended to be a designer-friendly front-end tooling framework that took away the agony that can be setting and spinning up a development environment. tl;dr You should be designing, not architecting and configuring. I'd even made a rough landing page for it.

NOTE: This project was awaiting features that were slated for 3.0, which never came.

Features

Brunchline is built with Brunch, and prefers utilizing Yarn over NPM.

Example Directory Structure

Project/
├── src/
│   ├── assets/
|   |   └── img/
|   |       └── filename.png
|   ├── js/
|       └── initialize.js
|   ├── scss/
|   |   ├── base.scss             [imports partials defined in each subfolder]
|   |   ├── vendor.scss           [imports vendor CSS, in this case, just normalize.css]
|   |   ├── core/
|   |   ├── components/
|   |   └── pages/
├── dist
│   ├── css/
|       └── app.css               [vendor.scss + base.scss]
|   ├── img/
|       └── filename.png
|   ├── js/
|       └── app.js                [initialize.js + other JS]
|   └── index.html

Installation

Node.js:

macOS

Windows

Linux

  • Linuxbrew: brew install node
  • Manually:
    • (If Ubuntu 16.04 or below:) curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
    • sudo apt-get install -y nodejs
    • sudo apt-get install -y build-essential

Yarn:

macOS

  • brew install yarn
  • (if using a Node Version Manager) brew install yarn --without-node

Windows

Linux (Ubuntu/Debian) (See this page for other distros)

  • curl -o- -L https://yarnpkg.com/install.sh | bash /etc/apt/sources.list.d/yarn.list

Brunch

  1. yarn global add brunch — Installs Brunch Globally
  2. yarn install — Installs project plugins & dependencies as defined in package.json.

Run

  • yarn run start — watches the project with continuous rebuild using brunch-auto-reload. This will also launch HTTP server with pushState.
  • yarn run build — builds minified project for production

About


Languages

Language:Pug 55.3%Language:SCSS 39.1%Language:JavaScript 5.5%