Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[N/A] Updates related to using ACF with Composer #160

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+12 −492,539
Open

[N/A] Updates related to using ACF with Composer #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
131dfb1
[N/A] Updates related to using ACF with Composer
bd-viget Oct 18, 2024
cc8d593
[N/A] Default README update
bd-viget Oct 18, 2024
cb1aa4d
[N/A] Remove ACF Plugin files from Repo.
bd-viget Oct 18, 2024
afe9863
[N/A] More instructions
bd-viget Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,13 @@ wp-config.php
!/wp-content/themes/wp-starter
!/wp-content/plugins/acf-blocks-toolkit
!/wp-content/plugins/viget-parts-kit
!/wp-content/plugins/advanced-custom-fields-pro

# Remove the theme.json file as it is built in the theme with Vite
/wp-content/themes/wp-starter/theme.json

# Remove the auth.json file since it contains sensitive information.
/wp-content/themes/wp-starter/auth.json

# Plugin generated folders
/wp-content/wflogs

Expand Down
2 changes: 1 addition & 1 deletion README.dist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is the README for your new site. Feel free to update any of this info to ma
* [Composer](https://getcomposer.org/) - [Installation](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos)
* [DDEV](https://ddev.readthedocs.io/en/stable/) - [Installation](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/)
* [Docker](https://docs.docker.com/desktop/install/mac-install/) (or compatible container alternative like OrbStack)
* For ACF Pro, create an `auth.json` file in `wp-content/mu-plugins/viget-base/` from the [ACF Website](https://www.advancedcustomfields.com/my-account/view-licenses/). (Credentials are in 1Password)
* For ACF Pro, create an `auth.json` file in `wp-content/themes/wp-starter/` from the [ACF Website](https://www.advancedcustomfields.com/my-account/view-licenses/). (Credentials are in 1Password). Update the password to the actual URL of the site, then run `composer require wpengine/advanced-custom-fields-pro` to install ACF Pro.

## Setup and Running
To start the local server and build process, run:
Expand Down
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,14 @@ Following the series of prompts, the project will be set up with the following:
2. **WordPress Core**: The latest version of WordPress will be downloaded.
3. **Local Development Environment**: A DDEV configuration file will be created and the local environment will be started.
4. **Theme Setup**: The theme will be set up with the project name and slug.
5. **ACF Pro**: If an `auth.json` file is present in the project root, ACF Pro will be installed.
6. **`package.json` Dependencies**: All necessary script and style build dependencies for the theme will be installed and initialized.
7. **Cleanup**: Any setup files will be removed and the project will be ready for development.
5. **`package.json` Dependencies**: All necessary script and style build dependencies for the theme will be installed and initialized.
6. **Cleanup**: Any setup files will be removed and the project will be ready for development.

### Adding ACF Pro via Composer

Create an `auth.json` file in the theme root directory from the [ACF Website](https://www.advancedcustomfields.com/my-account/view-licenses/). (Credentials are in 1Password). Update the password to the local URL, then run `composer require wpengine/advanced-custom-fields-pro` to install ACF Pro.

### Initial Commit

After the setup is complete, it is recommended to perform your initial commit and push to your project repository.

Expand Down
Loading