|
1 | 1 | # WPLib Box |
2 | 2 |
|
3 | | -**The EASIEST way to get a local WordPress development environment** |
| 3 | +**The Best Single-project Solution for Local WordPress Development** |
4 | 4 |
|
5 | 5 | ## Links |
6 | 6 | - [Quick Start](http://wplib.github.io/wplib-box/#quickstart) |
7 | 7 | - [Full Documentation](http://wplib.github.io/wplib-box/) |
8 | 8 | - [Interactive Help](https://wplib.slack.com) on [Slack](https://slackhq.com) <em>(Join [here](https://slackpass.io/wplib))</em> |
9 | 9 |
|
10 | 10 |
|
11 | | -## Release Candidate - NEW! |
12 | | - |
13 | | -We have a candiate for our next release available for testing! |
14 | | - |
15 | | -If you a familiar with WPLib Box [please help us test](#instructions-for-getting-0160). |
16 | | - |
17 | | - |
18 | | -## Instructions for getting 0.16.0 |
19 | | - |
20 | | -If you new to WPLib Box click [**here**](#new-to-wplib-box). If not, continue on. |
21 | | - |
22 | | -The following should work **for Mac users**: |
23 | | - |
24 | | -``` |
25 | | -cd ~/Sites |
26 | | -git clone https://github.com/wplib/wplib-box.git 0.16.0 |
27 | | -cd 0.16.0 |
28 | | -git checkout -b 0.16.0 origin/0.16.0 |
29 | | -vagrant up |
30 | | -sleep 3 |
31 | | -open "http://wplib.box" |
32 | | -``` |
33 | | -For **Windows** or **Linux** users you will probably need use a different directory on the first `cd` command. Pick the parent directory where you typically put your website projects. |
34 | | - |
35 | | -**Note:** The `sleep 3` command is needed if you run the commands in a script but not if you type the commands in manually one-by-one. |
36 | | - |
37 | 11 | ### New to WPLib Box? |
38 | 12 |
|
39 | | -If you are new to WPLib Box be sure to: |
40 | | - |
41 | 13 | - [**Install required software**](http://wplib.github.io/wplib-box/#required-hw) to support WPLib Box. |
42 | 14 |
|
43 | | -Once installedd [**return to getting**](#instructions-for-getting-0160) `0.16.0`. |
44 | | - |
45 | | -### If you get 404 Not Found on Vagrant Up |
46 | | -If you get a 404 error from `vagrant up` chances are you are on a `1.x` version of Vagrant and need to upgrade to a `2.x` version. The `1.x` version does not recognize the new Vagrant Cloud and still looks to [atlas.hashicorp.com](https://atlas.hashicorp.com) for our Vagrant image, which is obviously no longer there _(not sure why Hashicorp does not support redirects here, but maybe Vagrant `1.x` deoes not follow them?)_ |
47 | | - |
48 | | -Upgrading Vagrant to `2.x` then running `vagrant plugin repair` should resolve this issue. |
49 | | - |
50 | | -Here is what this error looks like on the command line: |
51 | | - |
52 | | -``` |
53 | | -$ vagrant up |
54 | | -Bringing machine 'default' up with 'virtualbox' provider... |
55 | | -==> default: Box 'wplib/wplib' could not be found. Attempting to find and install... |
56 | | - default: Box Provider: virtualbox |
57 | | - default: Box Version: 0.16.0 |
58 | | -The box 'wplib/wplib' could not be found or |
59 | | -could not be accessed in the remote catalog. If this is a private |
60 | | -box on HashiCorp's Atlas, please verify you're logged in via |
61 | | -`vagrant login`. Also, please double-check the name. The expanded |
62 | | -URL and error message are shown below: |
63 | | -
|
64 | | -URL: ["https://atlas.hashicorp.com/wplib/wplib"] |
65 | | -Error: The requested URL returned error: 404 Not Found |
66 | | -``` |
67 | | - |
68 | | -## How to Test |
69 | | -- **To help us QA our changes**, please review the [issues for the `0.16.0` milestone](https://github.com/wplib/wplib-box/milestone/24) and look for any that are marked _"Ready for QA"_ as we think those tickets should all be working. If we missed something, please add comments to the respective issue. |
70 | | -- **To review it for your own use-cases** go ahead and set up your own project to work with it and see if it meets your needs, if you struggle to understand anything, if anything does not work for you, or if you have an idea for how it can become better please [add an issue](https://github.com/wplib/wplib-box/issues/new). |
71 | | -- **Pay attention to performance.** We think this release resolved some performance issues we did not even know we had; it feels much faster to us. We'd like to know if it also feels faster to you. Let us know in the `#box` channel on our [Slack account](wplib.slack.com) <em>(join [here](https://slackpass.io/wplib).)</em> |
72 | | - |
73 | | - |
74 | 15 | ## Troubleshooting, Questions and Feedback/Bug Reports |
75 | 16 | - **If your browser times out** trying to load http://wplib.box check your `/env/hosts` file to see if you have more than one IP address entry mapped to the `wplib.box` domain and its various subdomains. |
76 | 17 | - **If you have questions** please post them in the `#box` channel on our [Slack account](https://wplib.slack.com) <em>(join [here](https://slackpass.io/wplib).)</em> |
|
0 commit comments