tivwp/skeleton-project

Skeleton project for WordPress applications

Maintainers

Details

github.com/TIVWP/skeleton-project

Source

Installs: 37

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

1.4.0 2022-12-13 13:03 UTC

Requires

  • composer-plugin-api: @stable
  • composer/installers: @stable
  • johnpbloch/wordpress: @stable
  • wpackagist-plugin/dummy-gateway-for-woocommerce: @stable
  • wpackagist-plugin/tivwp-email: @stable
  • wpackagist-plugin/woocommerce: @stable
  • wpackagist-plugin/wordpress-seo: @stable
  • wpackagist-plugin/wp-maintenance-mode: @stable
  • wpackagist-plugin/wpforms-lite: @stable
  • wpackagist-theme/storefront: @stable

Requires (Dev)

  • wpackagist-plugin/codepress-admin-columns: @stable
  • wpackagist-plugin/debug-bar: @stable
  • wpackagist-plugin/loco-translate: @stable
  • wpackagist-plugin/log-http-requests: @stable
  • wpackagist-plugin/post-meta-inspector: @stable
  • wpackagist-plugin/query-monitor: @stable
  • wpackagist-plugin/transients-manager: @stable
  • wpackagist-plugin/tweak-option: @stable
  • wpackagist-plugin/user-meta-display: @stable
  • wpackagist-plugin/user-switching: @stable
  • wpackagist-plugin/wp-crontrol: @stable
  • wpackagist-plugin/wp-mail-logging: @stable

GPL-3.0 af435a6f0db49885b732eb9f99cb434b4e01b8ed

This package is auto-updated.

Last update: 2024-04-13 16:45:55 UTC

README

FOR TIV.NET PROJECTS ONLY

Usage Example

cd /var/www
composer create-project tivwp/skeleton-project my-site.com

Composer will install the project and then will run the configuration script:

> tivwp_composer::post_create_project
Please enter the configuration values:
DB_NAME [my-site] :
DB_USER [my-site] (max. 16 chars) :
DB_PASSWORD :mysecretpassword
Domain name [my-site.com] :
Array
(
    [{{DB_NAME}}] => my-site
    [{{DB_USER}}] => my-site
    [{{DB_PASSWORD}}] => mysecretpassword
    [{{SITE_NAME}}] => my-site.com
    [{{PROJECT_ROOT}}] => /var/www/my-site.com
)

OK [Y/n]?
Processing files:
internal/dist/dbcreate.sql => internal/dbcreate.sql
internal/dist/wp-config.php => public/wp-config.php
internal/dist/httpd.conf => apache/httpd.conf

Go to the project folder:

cd /var/www/my-site.com

Run mysql to create the database and the user:

mysql -u root -p < internal/dbcreate.sql
Enter password: **********

Edit the public/wp-config.php file and replace the "Authentication Unique Keys and Salts" section with the content of https://api.wordpress.org/secret-key/1.1/salt/.

Edit the .gitignore file in the project root and uncomment the line:

/public/tivwp-local-config.inc.php

If on development server, edit the /etc/hosts file and put the following line there:

127.0.0.1 my-site.com www.my-site.com

Open the site in a browser to let WordPress set up the database tables:

https://my-site.com/wp/wp-admin/install.php

Note that if you did not install the real SSL certificate, your browser will issue a warning.

Complete the WordPress installation, login to the admin and then go to the General Settings:

https://my-site.com/wp/wp-admin/options-general.php

and change the Site Address (URL) so that it does not end with wp:

https://my-site.com

Keep the above part, WordPress Address (URL) as-is.

Alternatively, if you have WP-CLI installed, you can use it:

wp option update home 'https://my-site.com'

Clean-up

Edit the composer.json file:

  • Change these lines:
"name": "tivwp/skeleton-project",
"description": "Skeleton project for WordPress applications",
  • Remove these lines:
"scripts": {
    "post-create-project-cmd": [
      "tivwp_composer::post_create_project"
    ]
},
"autoload": {
    "classmap": [
      "internal"
    ]
},
  • Remove the internal folder.
  • Remove or modify README.md file in the project root folder.

That's All

The site is ready. Make a Git repo for it, commit and push.

Author

Gregory Karpinsky TIV.NET INC.