Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.17 KB

README.md

File metadata and controls

65 lines (47 loc) · 3.17 KB
Raw

Brutalist Framework 3.0.3

A framework for the brutalist web design trend.

BF Cover

About

Brutalist Framework is a free and open source collection of PHP & HTML templates, CSS libraries, and javascript resources specifically for the brutalist web design style.

Features:

  • Flat-file (no database needed)
  • Lightweight & portable
  • No third-party dependencies
  • Open source under MIT license

Ideal for:

  • Beginner & novice web designers and developers
  • Building lightweight and portable applications or small websites
  • Brutalizing your web presence

Technologies Used:

  • HTML5 / CSS3
  • Vanilla javascript & jquery
  • PHP
  • CSV, XML, and JSON

Getting Started

Although much of BF uses PHP, this isn't mandatory. You can use just the HTML, CSS, and javascript components if you're developing a static HTML page.

Otherwise, if you plan to utilize PHP, you'll need to use a server. If developing on a local machine, a WAMP, LAMP, or MAMP server will need to be used (depending on what operating system you're using).

If you plan to develop your project in a specific folder (directory), you'll need to specify the folder name ($basedir variable) in the bos/build/sysconfig.php script (ex: 'sub-dir'). Otherwise, it's best to build in either a root domain or subdomain folder.

App Directory

The /app directory is ideal for storing application content files, data, and media. Out-of-the-box, it includes some example files that are used throughout BF.

BOS Directory

The /bos directory contains CORE CSS libraries, javascript plugins, PHP scripts, and data files that can be used across your whole application.

The core contains additional (optional) resources called MOLDS which provide additional functionality for your app.

MOLDS

MOLDS (Modular Object Linked Data Source) will be modules included as part of the BOS backend. These modules will use CSV and XML data files, which will allow the rendering of dynamic content on the front-end of your app.

Core CSS

Core CSS libraries are found in the /bos/core/css directory. By default, all libraries are imported into the /bos/core/css/construct.css file, so only this file is needed. However, you may wish to load CSS libraries independently (ideal for development).

JAB

JAB (Javascript Application Base) contains all the javascript files for all CORE components. Both vanilla javascript and jQuery plugins are included in the /bos/core/jab directory.

Javascript files found in the /bos/core/jab directory are vanilla javascript (no dependencies), as well as jQuery libraries are found here. All javascript found in the core/jab/plugins directories are jQuery plugins, and require a jQuery library to be loaded before them.

Core Data

Core data files are found in the /bos/core/data directory. These data files are used to prepopulate various input components (such as dropdown selectors).

PHP Build Constructor

The only PHP file you'll need to require is: /bos/build/constructor.php.

This PHP script includes helper and constructor scripts, which are used to render PHP variables on the front-end.