Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonfriskics committed May 21, 2018
1 parent 21df786 commit 25a2097
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,35 @@
# best-reads
# Build a Reading List Application with Vue.js

> A Vue.js project
This repo contains the code for the Pluralsight Project "Build a Reading List Application with Vue.js"

## Build Setup
This Project was created with Vue 2.5.

``` bash
# install dependencies
## Installation Instructions and Verifying Local Environment

### Installation

Run the following command from root folder of the forked project to install all dependencies.

```
npm install
```

# serve with hot reload at localhost:8080
npm run dev
### Verify Setup

# build for production with minification
npm run build
In order to verify that everything is setup correctly, run the following command that should show you the failing tests.

# build for production and view the bundle analyzer report
npm run build --report
```
npm run test
```

This is good! We'll be fixing these tests once we jump into the build step. Every time you want to check your work locally you can type that command and it will report the status of every task in the project. In addition, each module has tests that can be run scoped to just the tasks in that module. See the instructions at the top of each list of tasks for more information.

# run unit tests
npm run unit
### Previewing Your Work

# run e2e tests
npm run e2e
In order to see your changes in a browser, you can type this to start the application.

# run all tests
npm test
```
npm run dev
```

For a detailed explanation on how things work, check out the [guide](http:https://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http:https://vuejs.github.io/vue-loader).
Then, when you visit http:https://localhost:8080 in a browser you should see the App.vue component's HTML and CSS rendered on the page.

0 comments on commit 25a2097

Please sign in to comment.