Skip to:
Content

BuddyPress.org

Opened 3 weeks ago

Last modified 9 days ago

#8317 new enhancement

Use @wordpress/env to ease BuddyPress contributors life

Reported by: imath Owned by: netweb
Milestone: 7.0.0 Priority: high
Severity: normal Version:
Component: Build/Test Tools Keywords: has-patch dev-feedback needs-codex
Cc:

Description (last modified by imath)

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 ​@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 ?

There's some great documentation ​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

Attachments (1)

8317.patch​ (2.1 KB) - added by imath 3 weeks ago.

Download all attachments as: .zip

Change History (7)

@imath
3 weeks ago

#1 @imath
3 weeks ago

  • Description modified (diff)

#2 @oztaser
3 weeks ago

Hi @imath ,

I liked the idea and I've tested your patch. It looks good.

@wordpress/env supports WP-CLI as far as I can see on the GitHub repository[1]. What do you think about including BP-CLI package to the environment like BP REST.

P.S: Default login credentials are username: admin password: password, it might be helpful.

[1] ​https://github.com/WordPress/gutenberg/tree/master/packages/env

#3 @imath
3 weeks ago

Thanks for your feedback @oztaser. You’re completely right, I’ll add BP CLIπŸ‘Œ

This ticket was mentioned in ​Slack in #buddypress by imath. ​View the logs.


3 weeks ago

#5 @mercime
2 weeks ago

Per meeting last Wednesday, June 17, tested patch on the following:

βœ… Windows 10 Pro and better - OK
βœ… Windows 10 Home on Insider Build with WSL 2 - OK
βœ… Ubuntu server - OK

Concerned about prospective contributors with Windows 10 Home (stable version) because Docker can't be installed on their machines.

#6 @imath
9 days ago

  • Keywords needs-codex added

Thanks a lot for your testing @mercime. It's very useful 😍. I understand your concern about users running Windows 10 home edition. But I believe it shouldn't block us to include this testing environment for all the other users.

I think we should write a codex page with the different ways you can set your development environment to start contributing to BuddyPress. It could look like this ​documentation page or include links to this documentation page.

Note: See TracTickets for help on using tickets.