Skip to content

zyml/nuswhispers-vue

Repository files navigation

NUSWhispers (Vue Port)

GitHub stars Dependency Status Build Status Coverage Status

Vue + TypeScript port of NUSWhispers' front-end application.

A personal experiment to replicate NUSWhispers's front-end application using Vue.

Warning: This is a WORK IN PROGRESS! It is undecided whether this web application will replace the existing one.

Screenshot Live Demo


Feature Parity Checklist

  • Core Layout
  • Featured
  • Latest
  • Popular
  • Categories
  • Tags
  • Single Confession
  • Search
  • Submit Confession
  • Privacy Policy
  • Authentication
  • Favorites
  • Likes
  • Comments

(Hipster) Checklist

  • TypeScript
  • TSLint
  • Vue
  • Vue Router
  • Vuex
  • ESLint (internal scripts only)
  • No jQuery / Bootstrap
  • CSS Modules
  • SVG Sprites
  • Autotrack (GA)
  • Webpack 2
  • Code Splitting
  • Jest
  • Travis CI
  • Code Coverage
  • Service Workers
  • E2E
  • Yarn
  • Server-side Rendering (SSR)
  • Title / Meta Management
  • > 90 Lighthouse Score

Requirements

  • Node 7.0+

Install / Build

  1. Copy .env.example as .env and fill in the keys.
  2. Run any of the following commands:
# Install dependencies
yarn

# Build
yarn run build

# Run server at http://localhost:8090/
yarn run start

# Run development server at http://localhost:8090/
yarn run watch

Credits

License

The MIT License (MIT). Please see License File for more information.