Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Aleksandr Beliaev committed Nov 13, 2022
1 parent 9f30cb8 commit f365678
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,33 @@ You can add any theme to it.

It's meant to be used with [ACF Pro](https://www.advancedcustomfields.com/), so that dependency is baked in.


## Installation

1. Install Lando 3.x and its prerequisites
2. Clone this repo and `cd` to the repo folder
3. Create an `.env` file and add your ACF Pro key here as `ACF_PRO_KEY`
4. Run `lando start`
5. Once finished, either continue with configuring the WP install manually by opening the site URL displayed in CLI or run `lando wpinstall` — this will perform an automated install of Wordpress, activate all plugins and install a default theme (twentytwentytwo).
3. Create an `.env` file and add:
1. your ACF Pro key here as `ACF_PRO_KEY`
4. Replace `lando-wp-site-template` and `lando-wp-site-theme` with your preferred name across the project (`.gitignore`, `.lando.yml`)
5. Run `lando start`
6. Once finished, either continue with configuring the WP install manually by opening the site URL displayed in CLI or run `lando wpinstall` — this will perform an automated install of Wordpress, activate all plugins and install a default theme (twentytwentytwo).

Next add your own theme in the mix and install it to the `themes` folder. Keep in mind that the name of the theme should be same with what you renamed `lando-wp-site-theme` to.

Next add your own theme in the mix. After installing it to the `themes` folder, replace lando-wp-site-theme with your theme name in all files across this repo (`.gitignore`, `.lando.yml`).

## Installation info and default credentials

Core Wordpress is installed into `/wp` folder, and all content goes into `/wp-content`. Couldn't be simpler!

Default credentials are the same as in the original [Lando Wordpress recipe](https://docs.lando.dev/config/wordpress.html) by default.
Default credentials are the same as in the original [Lando Wordpress recipe](https://docs.lando.dev/wordpress/getting-started.html) by default.


## Adding plugins

Add plugins to `composer.json` (Wordpress.org plugins can be added using https://wpackagist.org/). Run `lando composer update` to update plugins or install new ones.

New plugins installed via composer won't be automatically enabled to avoid issues, you will have to enable them yourself.


## Installation on server

Expand All @@ -34,6 +46,7 @@ You can omit the "Happy publishing!" part.

You should also add an `index.php` to the parent folder with an updated path to `wp-blog-header.php` file.


## Connecting to MySQL externally

Use port `32862` to connect to the database externally (eg. with [Sequel Ace](https://github.com/Sequel-Ace/Sequel-Ace)).

0 comments on commit f365678

Please sign in to comment.