Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stefanobartoletti/bricks

A modular WordPress starter theme powered by Bootstrap 5 and Gulp
https://github.com/stefanobartoletti/bricks

bootstrap bootstrap5 bricks font-awesome gulp hacktoberfest rollup wordpress wordpress-starter-theme wordpress-theme

Last synced: about 2 months ago
JSON representation

A modular WordPress starter theme powered by Bootstrap 5 and Gulp

Awesome Lists containing this project

README

        

![Bricks](.github/bricks-social.png)

_A modular WordPress starter theme powered by Bootstrap 5 and Gulp_

[![Release](https://img.shields.io/github/v/release/stefanobartoletti/bricks)](https://github.com/stefanobartoletti/bricks/releases/latest)
[![Last Commit](https://img.shields.io/github/last-commit/stefanobartoletti/bricks/devel)](https://github.com/stefanobartoletti/bricks/commits/devel)
[![Contributors](https://img.shields.io/github/contributors/stefanobartoletti/bricks)](https://github.com/stefanobartoletti/bricks/graphs/contributors)
[![Codacy](https://img.shields.io/codacy/grade/5dc7110e5216467b859b6319faf15d1e)](https://app.codacy.com/gh/stefanobartoletti/bricks)
![Snyk](https://img.shields.io/snyk/vulnerabilities/github/stefanobartoletti/bricks)

[Documentation](https://bricks.stefanobartoletti.it/) | [Changelog](https://github.com/stefanobartoletti/bricks/blob/master/CHANGELOG.md)

---

## 🌟 Features

- [Bootstrap 5](https://getbootstrap.com/) (compiled from source Sass and JavaScript files)
- [WP Bootstrap Navwalker](https://github.com/wp-bootstrap/wp-bootstrap-navwalker)
- Custom [Gulp](https://gulpjs.com/) tasks
- [Font Awesome 6](https://fontawesome.com/) (*SVG with JavaScript* version, parsed and minified by [gulp-fa-minify](https://github.com/FA-Minify/gulp-fa-minify))
- CSS bundling, including [Autoprefixer](https://autoprefixer.github.io/) and [PurgeCSS](https://purgecss.com/)
- JavaScript bundling with [Rollup](https://www.rollupjs.org/) and [Babel](https://babeljs.io/)
- Code linting with [ESLint](https://eslint.org/), [Stylelint](https://stylelint.io/) and [phpcs](https://github.com/squizlabs/PHP_CodeSniffer).
- [BrowserSync](https://www.browsersync.io/) live server.
- Automatic conversion of custom fonts into *woff2* web format
- Pre-localized templates in several languages ( 🇨🇿 Czech | 🇫🇷 French | 🇩🇪 German | 🇮🇹 Italian | 🇱🇹 Lithuanian | 🇪🇸 Spanish )
- Support for further localization by generation of a `.pot` [template file](https://developer.wordpress.org/themes/functionality/internationalization/)
- Support for integration of some optional JavaScript libraries

## ✅ Requirements

- [Git](https://git-scm.com/) to clone this repository.
- [Yarn](https://yarnpkg.com/) as the preferred tool to manage dependencies and run development scripts (you can also use plain [npm](https://nodejs.org/)).
- [Composer](https://getcomposer.org/) to manage PHP dependencies (Optional, used for PHP linting).
- [Advanced Custom Fields](https://www.advancedcustomfields.com/) (Regular or PRO) to take advantage of its integration with Bricks (Optional but strongly recommended).

## 📖 Documentation

Installation and configuration instructions and all features are documented on the [Bricks Documentation](https://bricks.stefanobartoletti.it/) website.

## 📃 Changelog

All updates up to the latest released version are documented in the [Changelog](https://github.com/stefanobartoletti/bricks/blob/master/CHANGELOG.md) file.

## 🤝 Contributing

If you want to contribute to Bricks make sure to read the [Contributing guidelines](https://github.com/stefanobartoletti/bricks/blob/master/.github/CONTRIBUTING.md).

Thanks to all contributors!

[![Contributors Display](https://contrib.rocks/image?repo=stefanobartoletti/bricks)](https://github.com/stefanobartoletti/bricks/graphs/contributors)

## 📝 License

[GNU GPLv3](https://github.com/stefanobartoletti/bricks/blob/master/LICENSE.txt)

Copyright © 2021-present [Stefano Bartoletti](https://github.com/stefanobartoletti)