Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dotsunited/wordpress-boilerplate

A barebones, clean and minimalist WordPress Boilerplate.
https://github.com/dotsunited/wordpress-boilerplate

wordpress

Last synced: about 20 hours ago
JSON representation

A barebones, clean and minimalist WordPress Boilerplate.

Host: GitHub
URL: https://github.com/dotsunited/wordpress-boilerplate
Owner: dotsunited
License: mit
Created: 2013-11-29T08:36:46.000Z (almost 11 years ago)
Default Branch: main
Last Pushed: 2024-11-04T12:10:33.000Z (14 days ago)
Last Synced: 2024-11-04T13:21:14.434Z (14 days ago)
Topics: wordpress
Language: PHP
Homepage: http://wordpress-boilerplate.dotsunited.de
Size: 8.94 MB
Stars: 15
Watchers: 8
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Dots United WordPress Boilerplate

A barebones, clean and minimalist WordPress Boilerplate, developed at
[Dots United](https://dotsunited.de/) as a foundation for modern, maintainable
and lightning fast WordPress based projects.

Gutenberg ready.

A Demo is available [here](http://wordpress-boilerplate.dotsunited.de/).

## Features

- [Maximum possible PageSpeed Insights score](https://developers.google.com/speed/pagespeed/insights/?url=http%3A%2F%2Fwordpress-boilerplate.dotsunited.de%2F&tab=mobile)
- [Bun](https://bun.sh) for fast all-in-one JavaScript runtime
- [Vite](https://github.com/vitejs/vite) for asset bundling
- [Composer](https://github.com/composer/composer) for PHP dependency management
- [Tailwind CSS](https://github.com/tailwindcss/tailwindcss) for utility-first CSS
- Clean, maintainable and scalable project structure
- No bloat

## Setup

Create new project with:

```bash
composer create-project dotsunited/wordpress-boilerplate my-project
```

## Docker

Adjust the `docker-compose.yml` to your needs using a `docker-compose.override.yml` file ().

You can add a database dump with the filename `dump.sql.gz` or `dump.sql` which will be imported on the first run. A new user with the following credentials will be automatically added:

```bash
Username: `localAdmin`
Password: `localPassword`
```

> ⚠️ Remember to remove or change the credentials in a production environment!

Multisite subfolders can be be configured by setting the `WORDPRESS_MULTISITE_PATHS` environment variable to e.g. `2=blog2,3=blog3`, resulting in the following URLs:

-
-
-

If nothing is set, the ID of the corresponding blog will be used as a path, resulting in the following URLs:

-
-
-

Start the Docker containers with

```bash
docker compose up -d
```

## Plugins

> ℹ️ Automatic updates for plugins & themes are disabled by default. You can enable them by removing or commenting the corresponding module in `wp-content/mu-plugins/wordpress-boilerplate/wordpress-boilerplate.php`.

If you uncommented sentry lines in `docker-compose.yml` install [WP Sentry](https://wordpress.org/plugins/wp-sentry-integration/)

Be careful when using plugins which depend on jQuery.

Gravity Forms for example will enqueue jquery once a form is embedded into a
post or page.

In this case, you might include the form via an iFrame. You can use the
[gravity-forms-iframe](https://github.com/bradyvercher/gravity-forms-iframe)
plugin for easier integration.

## Webfonts

It is recommended to use local webfonts and not from external CDN's like
Google Fonts.

You can use [google-webfonts-helper](https://gwfh.mranftl.com/fonts)
to download webfonts from Google Fonts.

## License