-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add one isntall command to rule them all and uninstall/ nuke deps com…
…mands #2772
- Loading branch information
Josh Pollock
committed
Oct 23, 2018
1 parent
f4c9da9
commit 4d3cdd0
Showing
8 changed files
with
83 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,8 +19,12 @@ Requires: git, npm, Grunt. | |
- `git clone [email protected]:CalderaWP/Caldera-Forms.git` | ||
- Switch directory | ||
- `cd Caldera-Forms.git` | ||
- npm install | ||
- `npm i` | ||
- If you are using your own local development environment: | ||
- `npm i && composer install` | ||
- If you are wish to use the provided local development environment | ||
- `composer dev:install` | ||
|
||
|
||
### Build For Release | ||
To create a build to ship to WordPress.org: | ||
`npm run package` | ||
|
@@ -75,21 +79,13 @@ The local server is [http://localhost:8228](http://localhost:8228) | |
|
||
|
||
#### Install Test Environment | ||
* Make sure all dependencies are installed: | ||
- `composer update && npm update` | ||
* Install local development environment | ||
- `composer wp:install | ||
- Runs installer. Make sure Docker is running. May take awhile. | ||
- `composer wp:activate` | ||
- Activates Caldera Forms and Gutenberg and sets permalinks. | ||
* Install local development environment, dependencies and setup test forms | ||
- `composer dev:install` | ||
- May take awhile. | ||
* Go to [http://localhost:8228](http://localhost:8228) and make sure you have a WordPress site and can login. | ||
- Username: admin | ||
- password: password | ||
|
||
* Install the tests forms and pages for them. | ||
- `composer wp:test:setup` | ||
- Adds forms needed for e2e tests and one page for each form. Useful for manual QA as well. | ||
|
||
### Test Structures | ||
* PHP tests go in /tests and are run using phpunit | ||
- Integration tests, which require WordPress, are in tests. These used to be all the tests we have. | ||
|
@@ -103,6 +99,8 @@ The local server is [http://localhost:8228](http://localhost:8228) | |
|
||
#### Commands | ||
##### Composer | ||
* `composer dev:install` - Installs dependencies, Docker-based test environment and sets up test forms. | ||
* `composer dev:destroy` - Deletes dependencies and the Docker-based test environment. | ||
* `composer wp:install` - Installs Docker-based test environment. | ||
* `composer wp:start` - Starts Docker-based test environment. | ||
* `composer wp:activate` - Activate plugins in Docker-based environment. | ||
|
@@ -111,6 +109,7 @@ The local server is [http://localhost:8228](http://localhost:8228) | |
* `composer wp:destroy` - Removes (including the database) the test environment and destroys containers. | ||
* `composer test:setup` - Adds test forms and puts them on pages. | ||
* `composer test:delete` - Delete test forms and pages the are on. | ||
* `composer nuke` - Deletes dependencies, including lock files -- NPM and Composer. | ||
|
||
##### Composer | ||
* `npm test` - Run JavaScript test watcher | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.