freeplanet/README.md

<div>

# FreePlanet

I finally started my FreePlanet project !<br>
I have a lot of ideas to which kind of features adding, to create an app in order to help people to find and connect each others, using categories, filters and many profiling details about yourself.
</div>

<div>
This app was made mixing all this languages and tools:<br>
<ul>
  <li>Quasar Framework</li>
  <li>Vue.js</li>
  <li>Typescript</li>
  <li>Progressive Web App (PWA) amazing native-looking apps</li>  
</ul>
Thanks to the Quasar Framework and TypeScript !

</div>
<br>

<br>

<div align="center">

[![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) -->

</div>

<div align="center">

[![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)

</div>

## Features ⚡️

- [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

## Installation 🔧 

**System prerequisites :**
- 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 TypeScript (Kevin Marrec proj)** : [GitHub](https://github.com/kevinmarrec/quasar-typescript)
* **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

This project using Vue.js and Typescript started in October 2018 using as a skeleton parts of the code of Kevin Marrec. So Thank you!

* Quasar TypeScript:
https://github.com/kevinmarrec/quasar-typescript
Copyright (c) 2018, Kevin Marrec