Giter Club home page Giter Club logo

bedrock's Introduction

Pixels Bedrock

Pixels Bedrock is a forked version of roots/bedrock, 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 methodology including the WordPress specific version.

Updates

Pixels Bedrock will be updated every 6 months, along the same timeline as the Pixels Starter Theme, merging in updates that have been made over the previous 6 months.

Issues, improvements and these instructions.

Please read the documentation below before using. If things are not clear or you find a mistake, or simply a way to improve the theme, please submit an issue or pull request.

Tools and Technologies

  • Dependency management with Composer
  • Easy WordPress configuration with environment specific files
  • Environment variables with Dotenv
  • Autoloader for mu-plugins (use regular plugins as mu-plugins)
  • Enhanced security (separated web root and secure passwords with wp-password-bcrypt)

Requirements

Installation

These instructions should cover most installation instances, for full project setup instructions a project including using Local by Flywheel, see here

  1. Download this repository as a ZIP (don't clone!).

  2. Drop it into your sites or equivalent development folder, and rename to be the project name.

  3. In Terminal run composer install in the root of this folder.

  4. Create an .env file by duplicating .env.example.

    cp .env.example .env

  5. Update the environment variables in the .env file:

  • DB_NAME - Database name
  • DB_USER - Database user
  • DB_PASSWORD - Database password
  • DB_HOST - Database host
  • WP_ENV - Set to environment (development, staging, production)
  • WP_HOME - Full URL to WordPress home (http://example.com)
  • WP_SITEURL - Full URL to WordPress including subdirectory (http://example.com/wp)
  • AUTH_KEY, SECURE_AUTH_KEY, LOGGED_IN_KEY, NONCE_KEY, AUTH_SALT, SECURE_AUTH_SALT, LOGGED_IN_SALT, NONCE_SALT using the [Roots WordPress Salt Generator][roots-wp-salt].
  1. Add theme(s) in web/app/themes as you would for a normal WordPress site.

  2. Set your site vhost document root to /path/to/site/web/ (/path/to/site/current/web/ if using deploys)

  3. Access WP admin at http://example.com/wp/wp-admin

Deploys

Pixels Bedrock sites are (ideally) deployed using Capistrano.

Deploy scripts are already in config/deploy.rb, project variables can be found in config/config.rb and environment deploy variables in config/deploy/<environment>.rb.

For deployment to servers that don't allow SSH connections etc, custom deployment scripts will need to be written.

Documentation

Original Bedrock documentation is available at https://roots.io/bedrock/docs/.

bedrock's People

Contributors

swalkinshaw avatar retlehs avatar austinpray avatar aaemnnosttv avatar qwp6t avatar alexsomeoddpilot avatar vladmirom avatar foxaii avatar louim avatar rasmusbe avatar fredriksundstrom avatar etcook avatar brandonshutter avatar starise avatar 8ig8 avatar thewunder avatar paultibbetts avatar petrpacas avatar reiz avatar rslnk avatar sergeyz avatar shaneog avatar kix avatar ssteinerx avatar eastmanenator avatar tangrufus avatar tobeycodes avatar tomasvotruba avatar iamskok avatar dartagan avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.