Skip to content

Commit

Permalink
Add package.json and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
altwohill committed Aug 21, 2018
1 parent bd555cc commit 58f8d87
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 4 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,19 @@ This is the standard base module used by Twohill & Co to get up and running in S

## Getting Started

`composer create-project twohill/silverstripe-standard-base /path/to/project`
Downloading and running the development environment:

`SS_DATABASE_PASSWORD=mypass docker compose`
```sh
composer init
composer require twohill/silverstripe-standard-base

`npm watch`
docker compose

yarn
yarn watch
```

Building for production
```sh
yarn build
```
3 changes: 3 additions & 0 deletions app/client/dist/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Build directory

Files built by `yarn build` will be copied here
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"example.env",
"docker-compose.yml",
"serve.config.js",
"webpack.config.js"
"webpack.config.js",
"app/client/dist/*",
]
}
}
40 changes: 40 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"name": "@twohill/silverstripe-standard-base",
"version": "1.0.0",
"description": "The standard base for frontend dev with SilverStripe",
"repository": "https://github.com/twohill/silverstripe-standard-base.git",
"author": "Al Twohill <al@twohill.nz>",
"license": "BSD-3-Clause",
"private": true,
"scripts": {
"build": "yarn && cross-env NODE_ENV=production webpack -p --bail --progress",
"watch": "cross-env NODE_ENV=development webpack-serve",
"css": "WEBPACK_CHILD=css npm run build",
"lint": "eslint client/src; sass-lint -v"
},
"devDependencies": {
"@babel/core": "^7.0.0-beta.55",
"@babel/preset-env": "^7.0.0-beta.55",
"babel-loader": "^8.0.0-beta.4",
"bootstrap": "^4.1.3",
"copy-webpack-plugin": "^4.5.2",
"cross-env": "^5.2.0",
"css-loader": "^1.0.0",
"eslint": "^5.1.0",
"eslint-config-airbnb": "^15.1.0",
"file-loader": "^1.1.11",
"jquery": "^3.3.1",
"mini-css-extract-plugin": "^0.4.1",
"node-sass": "^4.9.2",
"popper": "^1.0.1",
"popper.js": "^1.14.3",
"postcss-loader": "^2.1.6",
"resolve-url-loader": "^2.3.0",
"sass-loader": "^7.0.3",
"style-loader": "^0.21.0",
"url-loader": "^1.0.1",
"webpack": "^4.16.3",
"webpack-cli": "^3.1.0",
"webpack-serve": "^2.0.2"
}
}

0 comments on commit 58f8d87

Please sign in to comment.