Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jazz-man/wp-boilerplate

WordPress Boilerplate
https://github.com/jazz-man/wp-boilerplate

bedrock composer mu-plugins wordpress wp-boilerplate

Last synced: 6 days ago
JSON representation

WordPress Boilerplate

Host: GitHub
URL: https://github.com/jazz-man/wp-boilerplate
Owner: Jazz-Man
License: mit
Created: 2019-11-16T11:58:34.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-10-15T14:33:42.000Z (about 1 year ago)
Last Synced: 2024-05-06T07:01:55.231Z (6 months ago)
Topics: bedrock, composer, mu-plugins, wordpress, wp-boilerplate
Language: SCSS
Homepage:
Size: 1.17 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # [Bedrock](https://roots.io/bedrock/)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d3976320f0194b12a1db639dc2de5c78)](https://app.codacy.com/gh/Jazz-Man/wp-boilerplate?utm_source=github.com&utm_medium=referral&utm_content=Jazz-Man/wp-boilerplate&utm_campaign=Badge_Grade_Settings)

[![Packagist](https://img.shields.io/packagist/v/roots/bedrock.svg?style=flat-square)](https://packagist.org/packages/roots/bedrock)

[![Build Status](https://img.shields.io/circleci/build/gh/roots/bedrock?style=flat-square)](https://circleci.com/gh/roots/bedrock)

[![Follow Roots](https://img.shields.io/twitter/follow/rootswp.svg?style=flat-square&color=1da1f2)](https://twitter.com/rootswp)

Bedrock is a modern WordPress stack that helps you get started with the best development tools and project structure.

Much of the philosophy behind Bedrock is inspired by the [Twelve-Factor App](http://12factor.net/) methodology including the [WordPress specific version](https://roots.io/twelve-factor-wordpress/).

## Features

* Better folder structure

* Dependency management with [Composer](https://getcomposer.org)

* Easy WordPress configuration with environment specific files

* Environment variables with [Dotenv](https://github.com/vlucas/phpdotenv)

* Autoloader for mu-plugins (use regular plugins as mu-plugins)

* Enhanced security (separated web root and secure passwords with [wp-password-bcrypt](https://github.com/roots/wp-password-bcrypt))

## Requirements

* PHP >= 7.1

* Composer - [Install](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)

## Installation

1. Create a new project:

    ```sh

    $ composer create-project roots/bedrock

    ```

2. Update environment variables in the `.env` file. Wrap values that may contain non-alphanumeric characters with quotes, or they may be incorrectly parsed.

  * Database variables

    * `DB_NAME` - Database name

    * `DB_USER` - Database user

    * `DB_PASSWORD` - Database password

    * `DB_HOST` - Database host

    * Optionally, you can define `DATABASE_URL` for using a DSN instead of using the variables above (e.g. `mysql://user:[email protected]:3306/db_name`)

  * `WP_ENV` - Set to environment (`development`, `staging`, `production`)

  * `WP_HOME` - Full URL to WordPress home (https://example.com)

  * `WP_SITEURL` - Full URL to WordPress including subdirectory (https://example.com/wp)

  * `AUTH_KEY`, `SECURE_AUTH_KEY`, `LOGGED_IN_KEY`, `NONCE_KEY`, `AUTH_SALT`, `SECURE_AUTH_SALT`, `LOGGED_IN_SALT`, `NONCE_SALT`

    * Generate with [wp-cli-dotenv-command](https://github.com/aaemnnosttv/wp-cli-dotenv-command)

    * Generate with [our WordPress salts generator](https://roots.io/salts.html)

3. Add theme(s) in `web/app/themes/` as you would for a normal WordPress site

4. Set the document root on your webserver to Bedrock's `web` folder: `/path/to/site/web/`

5. Access WordPress admin at `https://example.com/wp/wp-admin/`

## Documentation

Bedrock documentation is available at [https://roots.io/bedrock/docs/](https://roots.io/bedrock/docs/).

## Contributing

Contributions are welcome from everyone. We have [contributing guidelines](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md) to help you get started.

## Bedrock sponsors

Help support our open-source development efforts by [becoming a patron](https://www.patreon.com/rootsdev).

  

## Community

Keep track of development and community news.

* Participate on the [Roots Discourse](https://discourse.roots.io/)

* Follow [@rootswp on Twitter](https://twitter.com/rootswp)

* Read and subscribe to the [Roots Blog](https://roots.io/blog/)

* Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)

* Listen to the [Roots Radio podcast](https://roots.io/podcast/)