Files
freeplanet/README.md
2018-12-10 11:38:22 +01:00

2.6 KiB
Raw Blame History

FreePlanet

A project made by Vue.js, Quasar Framework, Typescript, and Progressive Web App (PWA) amazing native-looking apps, thanks to the Quasar Framework and TypeScript

Made with Quasar Uses TypeScript

License MIT

js-standard-style

Build Coverage

Features (WIP)

  • TypeScript
  • Internationalization (I18n) ✔
  • ...

Built-in Tools 🔨

  • TSlint TypeScript 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:paoloar77/freeplanet example
$ cd example
$ yarn

Usage

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

Building

You can build your application for production using :

$ npm run dev:pwa # Build your PWA

References

License

MIT

Copyright (c) 2018-present, Paolo Arena