Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 3.75 KB

README.md

File metadata and controls

80 lines (60 loc) · 3.75 KB
Raw

WATS 4000 - Example Vue.js App for Testing

An example project for testing development environments.

This project asks you to set up your development environment, and then clone this repository. Once you've cloned the repository, you will need to complete the "Build Setup" below, and then you can run the development version of the site on your local machine.

The goal here is to test your development environment to make sure it works properly for the more complex work we will be doing later, and to start getting an idea of what files and parts are included when we use Vue-CLI to bootstrap a new project skeleton.

Before You Begin

Be sure to set up your local development environment first. You can follow the guidance in Practical JavaScript 2: Building Applications to get started. Don't hesitate to supplement that resource with others specific to your platform.

In order to run this project you will need an environment with the following:

  • Working installation of Node.js
  • Working installation of Git SCM
  • Working setup for your Github account

Basic Requirements

In order to successfully complete this project, fulfill the following requirements.

  • Set up your local development environment.

  • Fork this repository into your own Github account.

  • Clone this repository to your working development environment.

  • Install dependencies by running npm install in the root of the repository.

  • Test the site by running npm run serve to start the development server.

  • Read through the site code and note the following:

    • What directories do you see? How do you interpret their names?
    • Where is the Vue app defined? (Which file?)
    • What is listed in package.json?

  • Press ctrl-c in the terminal to exit the development server.

  • Run npm run build and take a look at both the webpage that comes up and the output in the console.
    Consider the following questions:

    • what is in the node_modules directory?
    • where can you find the directions for the scripts run with npm run, that is the serve and build scripts
    • what's the difference between the dependencies and devDependencies object in the package.json file?
    • Explore the docs directory. What do you see?
    • Do you see the filenames of the static files? What seems odd about those filenames?
    • Do you see the contents of your JS and CSS files? What has happened to those contents?
    • Three config files have been supplied for you: vue.config.js, aliases.config.js and .babel.config.js. What is the general purpose of each file.
    • Describe (in words and with a flowchart/diagram) what happens when the npm run build command is executed to the best of your ability.
    • Make a diagram of the components of this system like the ones shown in the Practical JavaScript 2: Building Applications book Types of Website Architectures. Do your best to document your interpretation of the architecture of this system.

  • Deploy your code to github.com and set up gh-pages on the docs directory.

Stretch Goals

If you crave a challenge, attempt some of these goals.

  • Modify some of the styles to present a nicer-looking app.
  • Add a message that is populated with data from the Vue component (and output it into the template).
  • Do some other fiddling with the logic to experiment and learn.

Build Setup

The following commands will help you work with this project.

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run serve

# build for production with minification
npm run build

For detailed explanation on how Vue works, check out the guide and docs for vue-loader.