Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.23 KB

README.md

File metadata and controls

71 lines (44 loc) · 2.23 KB
Raw

!!! Warning: This repo is now hosted by gothinkster. You can find the latest implementation of vue-realworld here

JavaScript Style Guide

RealWorld Example App

Vue.js codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo

This codebase was created to demonstrate a fully fledged fullstack application built with Vue.js including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Vue.js community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Getting started

Before contributing please read the following:

  1. RealWorld guidelines for implementing a new framework,
  2. RealWorld frontend instructions
  3. Realworld API endpoints
  4. Vue.js styleguide. Priority A and B categories must be respected.

The stack is built using vue-cli webpack so to get started all you have to do is:

# install dependencies
> npm install
# serve with hot reload at localhost:8080
> npm run dev

Other commands available are:

# build for production with minification
npm run build

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

# run single unit tests
npm run unit

# run continous unit tests
npm run units

# run e2e tests
npm run e2e

# run all tests
npm test

To know

Current arbitrary choices are:

  • Vuex modules for store
  • Vue-axios for ajax requests
  • Standard for linting
  • 'rwv' as prefix for components

These can be changed when the contributors reach a consensus.