[buddypress-trac] [BuddyPress Trac] #8317: Use @wordpress/env to ease BuddyPress contributors life

[buddypress-trac]

#8317: Use @wordpress/env to ease BuddyPress contributors life
------------------------------------+---------------------
 Reporter:  imath                   |       Owner:  netweb
     Type:  enhancement             |      Status:  new
 Priority:  high                    |   Milestone:  7.0.0
Component:  Build/Test Tools        |     Version:
 Severity:  normal                  |  Resolution:
 Keywords:  has-patch dev-feedback  |
------------------------------------+---------------------
Description changed by imath:

Old description:

> I believe we should make it easier for new contributors to quickly get
> started.
>
> Setting up a development environment can be a pain and is probably a
> major brake to contributions. Thanks to [https://developer.wordpress.org
> /block-editor/packages/packages-env/ @wordpress/env], we can now improve
> this. **I've just tested it: it's really awesome and we should include it
> asap into our repository**.
>
> What's needed ?
>
> - [https://nodejs.org/en/download/ Node.js (most of us already have it!)]
> - [https://www.docker.com/products/docker-desktop Docker Desktop]
> - The attached patch 😉
>
> There's some great documentation [https://developer.wordpress.org/block-
> editor/packages/packages-env/ there]. For our specific need we can use a
> `.wp-env.override.json` to customize the `.wp-env.json` I've added to the
> patch.
>
> For the regular `.wp-env.json`, I wrote it so that WordPress is latest
> stable, and the master branch of the BP REST API is automatically
> included and activated.
>
> To test:
> 1. Install Docker, launch it,
> 2. Apply the patch,
> 3. run this `npm run wp-env start` from the command line being at the
> root of the BuddyPress repository
> 4. Go to `http://localhost:8888`
> 5. Tada 🎉
>
> When, you need to stop, simply do `npm run wp-env stop`

New description:

 I believe we should make it easier for new contributors to quickly get
 started.

 Setting up a development environment can be a pain and is probably a major
 brake to contributions. Thanks to [https://developer.wordpress.org/block-
 editor/packages/packages-env/ @wordpress/env], we can now improve this.
 **I've just tested it: it's really awesome and we should include it asap
 into our repository**.

 What's needed ?

 - [https://nodejs.org/en/download/ Node.js (most of us already have it!)]
 - [https://www.docker.com/products/docker-desktop Docker Desktop]
 - The attached patch 😉

 There's some great documentation [https://developer.wordpress.org/block-
 editor/packages/packages-env/ there]. For our specific need we can use a
 `.wp-env.override.json` to customize the `.wp-env.json` I've added to the
 patch.

 For the regular `.wp-env.json`, I wrote it so that WordPress is latest
 stable, and the master branch of the BP REST API is automatically included
 and activated.

 To test:
 1. Install Docker, launch it,
 2. Apply the patch,
 3. Update node modules running `npm install`
 4. run this `npm run wp-env start` from the command line being at the root
 of the BuddyPress repository
 5. Go to `http://localhost:8888`
 6. Tada 🎉

 When, you need to stop, simply do `npm run wp-env stop`

--

-- 
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/8317#comment:1>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac