:octocat: Github + Vue = GitVub
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
docs
public
src
tests/unit
.babelrc
.editorconfig
.env
.eslintrc
.gitignore
.postcssrc
.travis.yml
LICENSE
README.md
package-lock.json
package.json
workbox-config.js

README.md

GitVub

Build Status Standard - JavaScript Style Guide tested with jest

GitHub + Vue.js = GitVub

A Vue.js Progressive Web App (PWA) based on GitHub API.

mobile screens

icon on desktop, splash screen and screen shot taken from this application

A demo is available here: https://gitvub.azurewebsites.net.

What's inside?

... using the GitHub Api (doc).

Based on vue-cli 3 and follow his file structure/conventions.

Notes

Testing service workers

$ npm install -g serve
$ npm run build && serve dist

Working with HTTPS

# first install ngrok (https://ngrok.com/)
$ npm install -g ngrok

# Terminal 1: (will run app on port 8080)
$ npm run dev

# Then on a 2nd terminal:
$ ngrok http 8080

ngrok by @inconshreveable                                                                                                                                                                                                   (Ctrl+C to quit)

Session Status                online
Version                       2.2.8
Region                        United States (us)
Web Interface                 http://127.0.0.1:4040
Forwarding                    http://ada5c26b.ngrok.io -> localhost:8080
Forwarding                    https://ada5c26b.ngrok.io -> localhost:8080

Connections                   ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00

You can now work with the HTTPS url given (in the example above: https://ada5c26b.ngrok.io)

Commands

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run serve

# build for production with minification
npm run build

# Run tests
npm test

# Run tests + generate coverage (available under /tests/unit/coverage)
npm test -- --coverage

# Run tests in watch node
npm test -- --watchAll

# Run tests + update snapshots if needed
npm test -- -u

For a detailed explanation on how things work, check out the guide and docs for vue-loader.