https://github.com/wp-forge/wp-site
Easily create a new Composer-based WordPress site.
https://github.com/wp-forge/wp-site
Last synced: 4 months ago
JSON representation
Easily create a new Composer-based WordPress site.
- Host: GitHub
- URL: https://github.com/wp-forge/wp-site
- Owner: wp-forge
- License: gpl-3.0
- Created: 2020-04-17T20:44:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T18:05:39.000Z (about 6 years ago)
- Last Synced: 2025-10-04T05:47:01.754Z (9 months ago)
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress Site
Easily create a new Composer-based WordPress site.
## Requirements
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Composer](https://getcomposer.org/doc/00-intro.md)
## Installation
Run this command in the terminal:
```
composer --remove-vcs create-project wp-forge/wp-site
```
Optionally append a directory name to the end of the command to customize the folder name that your project will be installed into.
The installation process will check your environment for the required PHP version and PHP extensions. If this presents a problem and you want to force install anyway, just add the `--ignore-platform-reqs` flag to the command.
## Usage
### With Laravel Valet
- Install [Homebrew](https://brew.sh/)
- Install [Laravel Valet](https://laravel.com/docs/7.x/valet#installation)
- Install MySQL using Homebrew: `brew install mysql`
- Start MySQL using Homebrew: `brew services start mysql`
- Set password to be `root` for the root user: `$(brew --prefix mysql)/bin/mysqladmin -u root password root`
- Run `composer create-project wp-forge/wp-site local`
- Run `valet link local` (unless you've already run `valet park` and are in your Valet root directory)
- Run `valet secure local`
- Run `cd local`
- Run `composer run wp db create` - You may need to rename the database in your `.env` file first if you don't want your database to be named `local`.
- Visit `https://local.test` (unless you set a different top level domain) in the browser to finish the WordPress installation.
If you want your site's domain to be something different, just replace all instances of the word `local` above with your desired name.
### With Local
- Install [Local](https://localwp.com/)
- Create a new WordPress site using the UI
- Navigate to the site's `app` directory in the terminal.
- Run `rm -rf public` to delete the `public` directory.
- Run `composer create-project wp-forge/wp-site public`
- Click the link in Local to visit the site in the browser.
## Configuration
Open up the `.env` file to edit database credentials or other WordPress constants.
## Reminders
Don't forget to:
- Update the project's meta data in the composer.json file.
- Customize the readme.md file for your project.