/vue-realworld-example-app

An exemplary real-world application built with Vue.js, Vuex, axios and different other technologies. This is a good example to discover Vue for beginners.

Primary LanguageVueMIT LicenseMIT

RealWorld Frontend 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.

Project demo is available at https://vue-vuex-realworld.netlify.com/#/

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
> yarn install
# serve with hot reload at localhost:8080
> yarn serve

Other commands available are:

# build for production with minification
yarn run build

# run unit tests
yarn run test:unit

To know

Current arbitrary choices are:

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

These can be changed when the contributors reach a consensus.

Connect

Join us on Discord