https://github.com/Gingernaut/Peridot

A fast and powerful Vue.js PWA boilerplate
https://github.com/Gingernaut/Peridot

boilerplate peridot pwa scss vue vue-pwa-boilerplate vuejs

Last synced: 3 months ago
JSON representation

A fast and powerful Vue.js PWA boilerplate

• Host: GitHub
• URL: https://github.com/Gingernaut/Peridot
• Owner: Gingernaut
• License: mit
• Created: 2017-10-03T05:07:49.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T19:18:49.000Z (over 3 years ago)
• Last Synced: 2024-05-07T21:02:04.238Z (6 months ago)
• Topics: boilerplate, peridot, pwa, scss, vue, vue-pwa-boilerplate, vuejs
• Language: Vue
• Homepage:
• Size: 9.53 MB
• Stars: 115
• Watchers: 3
• Forks: 14
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Peridot

A fully featured Vue 2.6 PWA boilerplate

![Screenshot](./docs/readme_resources/homepage.png)

## Features:

* 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](https://github.com/Unitech/pm2)

* Automatic removal of unused CSS/SCSS

* Global SCSS variables and easy theme customization

* Linting and formatting with [eslint](https://github.com/eslint/eslint) and [prettier](https://github.com/prettier/prettier)

* Uses [Buefy](https://buefy.github.io/#/) for styling

## Running

```bash

# Run in development

yarn run serve

# Building and running with Docker

docker build -t peridot .

docker run -p 8080:8080 peridot:latest

# Lint .vue, .js, .scss

yarn run lint

```

## Backend

Want a ready-to-go backend for this web app for user authentication and management, email verification and more? Check out [microAuth](https://github.com/gingernaut/microAuth), a FastAPI Python boilerplate that works out of the box with this project.

## Contributing

Pull requests are welcome and appreciated!