jigarbytes/jigarbytes

WordPress boilerplate with modern development tools, easier configuration, and an improved folder structure

dev-master 2019-04-17 04:49 UTC

Requires

• php: >=7.1
• composer/installers: ^1.4
• oscarotero/env: ^1.1.0
• roots/wordpress: 5.1.1
• roots/wp-config: 1.0.0
• roots/wp-password-bcrypt: 1.0.0
• vlucas/phpdotenv: 2.2.1

Requires (Dev)

• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: dev-master

MIT

• Bytes

• composer
• wordpress
• vagrant
• stack
• wp

README

Features

• Better folder structure
• 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

• PHP >= 7.1
• Composer - Install

Installation

1. Create a new project:

   $ composer create-project jigarbytes/jigarbytes

2. Update environment variables in the .env file:

• 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:password@127.0.0.1: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
  • Generate with our WordPress salts generator

1. Add theme(s) in web/app/themes/ as you would for a normal WordPress site
2. Set the document root on your webserver to Bedrock's web folder: /path/to/site/web/
3. Access WordPress admin at https://example.com/wp/wp-admin/

Contributing

Contributions are welcome from everyone. We have contributing guidelines to help you get started.