diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..deb9647 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,7 @@ +Copyright 2017 Joe Fleming + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..2189b19 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# loopback-vue-app + +[Loopback](https://loopback.io) + [Vue.js](vuejs.org) + [Webpack](http://webpack.js.org/) boilerplate app. + +# Use + +Install your dependencies (developed with `yarn`) and write your app. + +Includes several scripts to help you out. + +## Scripts + +`dev`: Start the dev server, with webpack bundling and hot module reloading + +`lint`: Lints the project + +`test`: Runs tests, and follows up with linting and advisory check using `nsp` + +`build`: Create the bundled client build and write output to `/client` + +`start`: Starts the server in production mode (requires that you ran `build` previously) + +## Development + +- Changes to `/server` or `/common` restart the server via `nodemon` +- Changes to `/src` rebuild the client-side code via `webpack` +- Hot module reloading is used to push changes directly to your browser without reloading + +## Production + +Build the frontend, (re)install modules with `--production` flag, and run `npm start`. diff --git a/package.json b/package.json index 6d0b1a6..318a979 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "02-customer-portal", - "version": "1.0.0", + "name": "loopback-vue-app", + "version": "0.1.0", "main": "server/server.js", "scripts": { "lint": "eslint .", @@ -46,9 +46,9 @@ "webpack-merge": "^2.4.0" }, "repository": { - "type": "", - "url": "" + "type": "git", + "url": "https://github.com/w33ble/loopback-vue-app.git" }, "license": "MIT", - "description": "02-customer-portal" + "description": "Loopback + Vue.js + Webpack boilerplate app" }