Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Leverage npm scripts instead of requiring gulp to be installed globally. #280

Merged
merged 1 commit into from Nov 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
Expand Up @@ -11,15 +11,14 @@ For the full documentation, please check out [the Bedrock website](https://bedro
## Basic installation & first run

* First, make sure you have Node 8.3 or later installed. You can find the latest version of Node at [Nodejs.org](https://nodejs.org/en/).
* You need to have `gulp` installed globally to use Bedrock. `npm install -g gulp`.
* Install the project's dependencies:
* `npm install`
* Run `gulp` to start your project.
* Run `npm start` to start your project.

## Major commands

* `gulp`: runs the prototype
* `gulp build`: create a build (which ends up in the `dist` folder) that can be deployed to a server
* `npm start`: runs the prototype
* `npm run build`: create a build (which ends up in the `dist` folder) that can be deployed to a server

## Upgrading bedrock

Expand Down
4 changes: 3 additions & 1 deletion package.json
Expand Up @@ -4,7 +4,9 @@
"description": "Static site generator to easily make HTML prototypes",
"main": "gulpfile.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "echo \"Error: no test specified\" && exit 1",
"start": "gulp",
"build": "gulp build"
},
"repository": {
"type": "git",
Expand Down