Skip to content

Commit

Permalink
#2167 document npm commands in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh Pollock committed Apr 19, 2018
1 parent 3ba402e commit 361caae
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 4 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,44 @@ Requires: git, npm, Grunt.
- `cd Caldera-Forms.git`
- npm install
- `npm i`
### Build For Release
To create a build to ship to WordPress.org:
`npm run package`

###
-
This creates `/build/<version>` where `<version>` is the current version set in `package.json`.
### Development

Run watcher for development to auto-compile JavaScript and CSS

#### `/clients/`
This is the new stuff, built with webpack. Eventually everything UI will be here.

* Clients:
* pro - The Caldera Forms Pro admin page and tab in the editor.
* blocks - The Gutenberg block(s).
* admin - The main admin page. Work in progress, not used in plugin.
* viewer - The entry viewer. Work not in progress, not used in plugin.
* editor - Theoretical.

* Build for development and start watcher.
- `npm run dev`
* Build for production
- `npm run build:webpack`

#### `/assets/`
This is the old stuff, built with grunt.


* Build for development and start watcher.
- `npm run dev:grunt`
* Build for production
- `npm run build:grunt`

## Contributing/ Using This Repo, Etc.
* The default branch is "master" that should be the same as WordPress.org.
* Development happens on the "develop" branch.
* If you find a bug, or would like to make a feature request, [please open an issue](https://github.com/CalderaWP/Caldera-Forms/issues/).
* If you fixed a bug, or made a new feature, please submit a pull request against the develop branch.


## Contributing/ Using This Repo, Etc.
Expand Down
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@
"homepage": "https://github.com/CalderaWP/Caldera-Forms#readme",
"scripts": {
"build": "grunt && cross-env BABEL_ENV=default NODE_ENV=production webpack",
"build:webpack" : "cross-env BABEL_ENV=default NODE_ENV=production webpack",
"build:grunt" : "grunt",
"dev": "cross-env BABEL_ENV=default webpack --watch",
"dev:webpack": "cross-env BABEL_ENV=default webpack --watch",
"dev:grunt" : "grunt watch",
"version": "grunt version_number",
"grunt-watch" : "grunt watch",
"package": "npm run build && grunt "
"package": "npm run build && grunt build"
},
"browserslist": [
"last 2 versions",
Expand Down

0 comments on commit 361caae

Please sign in to comment.