# 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](https://img.shields.io/badge/made%20with-Quasar-blue.svg?style=for-the-badge)](https://github.com/quasarframework/quasar) [![Uses TypeScript](https://img.shields.io/badge/uses-TypeScript-3F51B5.svg?style=for-the-badge)](https://github.com/Microsoft/TypeScript) [![License MIT](https://img.shields.io/github/license/paoloar77/freeplanet-blue.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) [![Build](https://img.shields.io/circleci/project/github/paoloar77/freeplanet/master.svg?style=for-the-badge)](https://circleci.com/gh/paoloar77/freeplanet/tree/master) [![Coverage](https://img.shields.io/codecov/c/github/paoloar77/freeplanet/master.svg?style=for-the-badge)](https://codecov.io/gh/paoloar77/freeplanet/branch/master)
## Features ⚡️(WIP) - [TypeScript](https://github.com/Microsoft/TypeScript) ✔ - Internationalization (I18n) ✔ - ... ## Built-in Tools 🔨 - [TSlint](https://github.com/palantir/tslint) TypeScript Linter configured with the [Standard](https://github.com/standard/standard) JavaScript Code Style - Testing Suite using [Jest](https://github.com/facebook/jest) (See `Testing` section) - Configurable CI Pipeline using [CircleCI](https://circleci.com/) & [Codecov](https://codecov.io) (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 : ```bash $ git clone git@github.com:paoloar77/freeplanet example $ cd example $ yarn ``` ## Usage ```bash $ yarn dev # Start a SPA server $ yarn dev:ssr # Start a SSR + PWA server ``` ## Building You can build your application for production using : ```bash $ npm run dev:pwa # Build your PWA ``` ## References * **Quasar 0.17.15** : [Website](https://quasar-framework.org) | [Documentation](https://quasar-framework.org/guide) | [Github](https://github.com/quasarframework/quasar) * **Vue I18n 8.1.0** : [Website](https://kazupon.github.io/vue-i18n) | [Documentation](https://kazupon.github.io/vue-i18n/guide/started.html) | [Github](https://github.com/kazupon/vue-i18n) ## License [MIT](https://opensource.org/licenses/MIT) Copyright (c) 2018-present, Paolo Arena