Note: These instructions are specifically for Windows. Other operating systems might be different, but will use similar concepts.
Required on your computer for this setup: Local by Flywheel, Composer, Node
- Download site code from GitHub.
- Create new Local by Flywheel site with default settings. Example name: giving
- Copy GitHub site code into app folder (/giving/app)
- in /giving/conf/nginx/site.conf.hbs, change the root path code to:
root "C:\Users\YourUsername\Local Sites\giving\app\web";
Note: the GitHub docs give different root path instructions based on an earlier version of Local by Flywheel - Terminal: in /giving/app:
composer install --prefer-source
(will likely take 30 - 60 min) - Terminal: in /giving/app:
npm install - Terminal: in /giving/app:
npm run-script build - Terminal: in /giving/app/web/wp-content/plugins/cmb2* folders (4 total):
composer install --prefer-source - Terminal: in /giving/app/web/wp-content/plugins/carbon-fields-plugin:
composer install --prefer-source - Terminal: in /giving/app/web/wp-content/plugins/user-switching:
composer install --prefer-source - Note: In the GitHub Local Environment docs, the .env step is not working
- In /giving/app/web/wp:
Delete wp-config.php - Copy contents of /giving/app/web/wp/wp-config-local.php into /giving/app/config/environments/local.php, replacing similar variables already there. Delete anything redundant.
- In /giving/app/config/environments/local.php:
Fill out info, using the following as defaults (this is what Local by Flywheel uses): database name = 'local'. User = 'root'. Password = 'root'. Host = 'localhost'.
Beneath the database variables, add: $table_prefix = "wp_"; - Download database from Pantheon
- Go to Local by Flywheel's Adminer dashboard
- Drop tables in local.sql
- Import new database from Pantheon into local.sql
- In database "options" table, change both the home and siteurl values to http://giving.local
- Go to site in Local by Flywheel. The dashboard may show errors that the database isn't connected, but this happens even when the database is successfully connected. So just ignore.
- Start the site and view the site. Hopefully, you can see it!
- When you go to the WP admin dashboard (go to it via Local by Flywheel), it may show a 404. But, you should see the topbar of the dashboard and still be able to get there successfully.
- If you make CSS changes (which should happen in .scss files rather than style.css), compile them using CLI by typing: grunt