Skip to content

WordPress boilerplate with Composer, easier configuration, and an improved folder structure

License

Notifications You must be signed in to change notification settings

eighteen73/nebula

Repository files navigation

Nebula

Overview

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

Much of the philosophy behind Nebula is inspired by the Twelve-Factor App methodology including the WordPress specific version.

Nebula is heavily based on Bedrock by Roots with an eighteen73 flavour.

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 more secure password algorithm)

Requirements

Installation

  1. Create a new project:
    $ composer create-project eighteen73/nebula
  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:password@127.0.0.1:3306/db_name)
  • WP_ENVIRONMENT_TYPE - 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
  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 Nebula's web folder: /path/to/site/web/
  3. Access WordPress admin at https://example.com/wp/wp-admin/

About

WordPress boilerplate with Composer, easier configuration, and an improved folder structure

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages