g-u-c/guc-desktop - Githubissues

# Git-Utopian-Contributor Desktop

[![Made with Quasar](https://img.shields.io/badge/made%20with-Quasar-blue.svg?style=for-the-badge)](https://github.com/quasarframework/quasar) [![License MIT](https://img.shields.io/github/license/g-u-c/guc-desktop.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![js-standard-style](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

Features ⚡

Pug Template Engine ✔
Internationalization (I18n) ✔
SSR compliant using Quasar SSR ✔
Electron Interface

Built-in Tools 🔨

ESlint Javascript Linter configured with the Standard JavaScript Code Style
Testing Suite using Jest (See Testing section)
Configurable CI Pipeline using CircleCI & Codecov (See CI Pipeline section)

Installation 🔧

System prerequisites :

Pretested on Windows, Mac & Linux
Node.js 8 LTS or 10 latest
yarn > 1.9 (no guarantees if you prefer to use npm)

Clone this repository :

$ git clone git@github.com:g-u-c/guc-desktop
$ cd guc-desktop
$ yarn
$ quasar dev --mode electron

Usage

$ yarn dev # Start a SPA server
$ yarn dev:ssr # Start a SSR + PWA server
$ yarn dev:electron # Start electron

Testing (WIP)

CI Pipeline (WIP)

Building

You can build your application for production using :

$ yarn build # Build your SPA (it places the artifacts at /dist/spa-mat)
$ yarn build:ssr # Build your SSR + PWA (it places the artifacts at /dist/ssr-mat)
$ yarn build:electron # Build your electron

If you want then to clean build artifacts, just do :

$ yarn build:clean

Serving

You can serve your production ready application locally using :

$ yarn serve # Serve your SPA
$ yarn serve:ssr # Serve your SSR + PWA

By default, SPA and SSR apps are respectively served on ports 4000 and 3000

You can override the port using an environment variable :

$ PORT=3210 yarn serve # Serve your SPA on port 3210
$ PORT=3210 yarn serve:ssr # Serve your SSR + PWA on port 3210

Deploy with Now.sh

Deploying with Now is a breeze. The Now CLI is already shipped in the starter kit development dependencies so all you need to do is :

$ yarn deploy # Deploy your SPA on Now.sh
$ yarn deploy:ssr # Deploy your SSR + PWA on Now.sh

You might want to use a "now alias" or connect your domain to Now - or even look into automatic deployment with their Github integration.

Now.sh will install the dependencies automatically then run $ yarn start. Your website will be up and running on an HTTPS connection in a matter of seconds !

References

Quasar 0.17.15 : Website | Documentation | Github
Vue I18n 8.1.0 : Website | Documentation | Github

License

MIT

g-u-c / guc-desktop

readme