macpankiewicz / Peridot

A powerful Vue.js PWA boilerplate with Server Side Rendering

Peridot

A powerful Vue.js boilerplate with Vue-Router and Vuex

Features:

• Server Side Rendering (SSR) with injected meta tags for SEO
• Progressive Web App (PWA) with Service Worker
• Code splitting and async component/route loading
• Automatic hot-reload in development
• Dockerized production setup with pm2 load balancing
• Automatic removal of unused CSS/SCSS
• Global SCSS variables and easy theme customization
• Linting and formatting with eslint and stylelint
• Uses Buefy for styling

Coming Soon

• Email contact form with Sendgrid.

Running

# Run in development
yarn run dev

# Building and running with Docker
docker build -t peridot .
docker run -p 8080:8080 peridot:latest

# Lint .vue, .js, .scss
yarn run lint

# See wepback build breakdown
npm run build --report

Configuration (optional)

You can tweak settings in config/. base.js contains all settings, which you can choose to override for specific environments in dev.js and prod.js. Import oracle.js anywhere you need configuration options.

Contributing Guide

Credits

The following resources were extremely helpful for configuring webpack and SSR:

• https://ssr.vuejs.org/
• https://github.com/vuejs/vue-hackernews-2.0
• https://github.com/crisbal/vue-webpack-ssr-fully-featured
• https://github.com/wemake-services/wemake-vue-template