Steps to Set Up the Project Locally

Follow these instructions to get your local WordPress environment up and running.

1. Clone the Repository

git clone https://your-repo-url.git
cd link-up-lab

2. Create the .env File

Create a file named .env in the root of your theme directory and configure your environment variables as needed. Example:

#Use this file tu setup your local virtualhost as proxy for port 3000
#Copy - paste this file, and rename it as .env

LOCAL_SERVER_URL=https://linkuplab.lndo.site #Add your virtualhost url

## IMPORTANT!
# Browser sync server will provide you a local and external url
# You could use internal url to develop your app
# You could use external url for test your app on your own mobile device

3. Install PHP Dependencies

composer install

4. Access the Site and Run the WordPress Installer

Visit your local site URL and complete the WordPress installation via the setup form.

5. Install Node.js Dependencies

npm install

This installs all JavaScript dependencies required to compile the theme assets.

6. Activate the Theme

In the WordPress admin dashboard, activate the White Canvas – FSE Theme.

7. Activate Required Plugins

Activate the Advanced Custom Fields (ACF) plugin from the Plugins screen.

8. After Creating a New Module

Make sure your local main branch is up to date:

git checkout main
git fetch -p
git rebase

Build the assets

Whenever you create a new module or update assets, run in the theme folder:

npm run build

Sync your ACF fields

Make sure your ACF fields are synced by going to ACF >> Field Groups >> Sync Available

Environment Compatibility

Make sure you're using the following versions:

node -v
v20.11.0

npm -v
10.2.4

josepedrodiaz/Setup-white-canvas-readme.md