Creating GitHub project FreePlanet
This commit is contained in:
59
README.md
59
README.md
@@ -1,8 +1,9 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
# Quasar TypeScript
|
# 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
|
||||||
|
|
||||||
A starter kit to build powerful and amazing native-looking apps, thanks to the Quasar Framework and TypeScript
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -11,7 +12,7 @@ A starter kit to build powerful and amazing native-looking apps, thanks to the Q
|
|||||||
[](https://github.com/quasarframework/quasar)
|
[](https://github.com/quasarframework/quasar)
|
||||||
[](https://github.com/Microsoft/TypeScript)
|
[](https://github.com/Microsoft/TypeScript)
|
||||||
|
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -19,17 +20,15 @@ A starter kit to build powerful and amazing native-looking apps, thanks to the Q
|
|||||||
|
|
||||||
[](https://github.com/standard/standard)
|
[](https://github.com/standard/standard)
|
||||||
|
|
||||||
[](https://circleci.com/gh/kevinmarrec/quasar-typescript/tree/master)
|
[](https://circleci.com/gh/paoloar77/freeplanet/tree/master)
|
||||||
[](https://codecov.io/gh/kevinmarrec/quasar-typescript/branch/master)
|
[](https://codecov.io/gh/paoloar77/freeplanet/branch/master)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Features ⚡️(WIP)
|
## Features ⚡️(WIP)
|
||||||
|
|
||||||
- [TypeScript](https://github.com/Microsoft/TypeScript) ✔
|
- [TypeScript](https://github.com/Microsoft/TypeScript) ✔
|
||||||
- [Pug](https://github.com/pugjs/pug) Template Engine ✔
|
|
||||||
- Internationalization (I18n) ✔
|
- Internationalization (I18n) ✔
|
||||||
- SSR compliant using Quasar SSR ✔
|
|
||||||
- ...
|
- ...
|
||||||
|
|
||||||
## Built-in Tools 🔨
|
## Built-in Tools 🔨
|
||||||
@@ -47,7 +46,7 @@ A starter kit to build powerful and amazing native-looking apps, thanks to the Q
|
|||||||
|
|
||||||
Clone this repository :
|
Clone this repository :
|
||||||
```bash
|
```bash
|
||||||
$ git clone git@github.com:kevinmarrec/quasar-typescript example
|
$ git clone git@github.com:paoloar77/freeplanet example
|
||||||
$ cd example
|
$ cd example
|
||||||
$ yarn
|
$ yarn
|
||||||
```
|
```
|
||||||
@@ -59,54 +58,14 @@ $ yarn dev # Start a SPA server
|
|||||||
$ yarn dev:ssr # Start a SSR + PWA server
|
$ yarn dev:ssr # Start a SSR + PWA server
|
||||||
```
|
```
|
||||||
|
|
||||||
## Testing (WIP)
|
|
||||||
|
|
||||||
## CI Pipeline (WIP)
|
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
You can build your application for production using :
|
You can build your application for production using :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ yarn build # Build your SPA (it places the artifacts at /dist/spa-mat)
|
$ npm run dev:pwa # Build your PWA
|
||||||
$ yarn build:ssr # Build your SSR + PWA (it places the artifacts at /dist/ssr-mat)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
If you want then to clean build artifacts, just do :
|
|
||||||
```bash
|
|
||||||
$ yarn build:clean
|
|
||||||
```
|
|
||||||
|
|
||||||
## Serving
|
|
||||||
|
|
||||||
You can serve your production ready application locally using :
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ 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 :
|
|
||||||
```bash
|
|
||||||
$ 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](https://zeit.co/now) is a breeze. The Now CLI is already shipped in the starter kit development dependencies so all you need to do is :
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ 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](https://zeit.co/blog/now-for-github).
|
|
||||||
|
|
||||||
`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
|
## References
|
||||||
* **Quasar 0.17.15** : [Website](https://quasar-framework.org) | [Documentation](https://quasar-framework.org/guide) | [Github](https://github.com/quasarframework/quasar)
|
* **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)
|
* **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)
|
||||||
@@ -115,4 +74,4 @@ $ yarn deploy:ssr # Deploy your SSR + PWA on Now.sh
|
|||||||
|
|
||||||
[MIT](https://opensource.org/licenses/MIT)
|
[MIT](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
Copyright (c) 2018-present, Kevin Marrec
|
Copyright (c) 2018-present, Paolo Arena
|
||||||
|
|||||||
@@ -168,8 +168,8 @@ module.exports = function (ctx) {
|
|||||||
workboxPluginMode: 'InjectManifest',
|
workboxPluginMode: 'InjectManifest',
|
||||||
// workboxOptions: {},
|
// workboxOptions: {},
|
||||||
manifest: {
|
manifest: {
|
||||||
name: 'My App',
|
name: 'Free Planet',
|
||||||
short_name: 'myapp',
|
short_name: 'freeplanet',
|
||||||
description: 'Descrizione APP!',
|
description: 'Descrizione APP!',
|
||||||
display: 'standalone',
|
display: 'standalone',
|
||||||
orientation: 'portrait',
|
orientation: 'portrait',
|
||||||
|
|||||||
@@ -30,6 +30,6 @@ register(process.env.SERVICE_WORKER_FILE, {
|
|||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
// ServiceWorkerRegistration: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration
|
// ServiceWorkerRegistration: https://developer.mozilla.org/en-uk/docs/Web/API/ServiceWorkerRegistration
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -146,7 +146,7 @@
|
|||||||
style="fill:#42a5f5;fill-opacity:1"
|
style="fill:#42a5f5;fill-opacity:1"
|
||||||
mask="none"
|
mask="none"
|
||||||
clip-path="none"
|
clip-path="none"
|
||||||
d="m 9395.9474,-738.70387 a 1245.372,1245.372 0 0 0 120.6501,-290.02213 l -280.8618,-162.1557 c 20.99,-113.2034 20.8488,-228.0063 0.563,-338.9302 -132.1008,-34.4521 -264.2238,-46.1283 -393.9448,-34.635 174.7471,260.1165 238.2017,596.32248 185.2582,973.02076 l 176.7612,102.05309 a 1245.372,1245.372 0 0 0 191.5741,-249.33082 z"
|
d="m 9395.9474,-738.70387 a 1245.372,1245.372 0 0 0 120.501,-290.02213 l -280.8618,-162.1557 c 20.99,-113.2034 20.8488,-228.0063 0.563,-338.9302 -232.1008,-34.4521 -264.2238,-46.1283 -393.9448,-34.635 174.7471,260.1165 238.2017,596.32248 185.2582,973.02076 l 176.7612,102.05309 a 1245.372,1245.372 0 0 0 191.5741,-249.33082 z"
|
||||||
id="path8864-4-8-1-2-4-4-4" />
|
id="path8864-4-8-1-2-4-4-4" />
|
||||||
<path
|
<path
|
||||||
id="path8866-7-5-5-0-6-4-7"
|
id="path8866-7-5-5-0-6-4-7"
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 8.4 KiB |
@@ -72,12 +72,11 @@
|
|||||||
},
|
},
|
||||||
data: function () {
|
data: function () {
|
||||||
return {
|
return {
|
||||||
prova: 'AA',
|
|
||||||
selectOpLang: [
|
selectOpLang: [
|
||||||
{label: 'Italian', icon: 'fa-facebook', value: 'it'},
|
{label: 'English (UK)', icon: 'fa-flag-us', value: 'en-uk'},
|
||||||
{label: 'English (US)', icon: 'fa-flag-us', value: 'en-us'},
|
{label: 'German', icon: 'fa-flag-de', value: 'de'},
|
||||||
{label: 'Spanish', icon: 'fa-flag-es', value: 'es'},
|
{label: 'Spanish', icon: 'fa-flag-es', value: 'es'},
|
||||||
{label: 'German', icon: 'fa-flag-de', value: 'de'}
|
{label: 'Italian', icon: 'fa-facebook', value: 'it'}
|
||||||
],
|
],
|
||||||
lang: this.$q.i18n.lang,
|
lang: this.$q.i18n.lang,
|
||||||
leftDrawerOpen: this.$q.platform.is.desktop
|
leftDrawerOpen: this.$q.platform.is.desktop
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { Component, Vue } from 'vue-property-decorator';
|
import { Component, Vue } from 'vue-property-decorator'
|
||||||
|
|
||||||
@Component
|
@Component
|
||||||
export default class HelloWorld extends Vue {
|
export default class HelloWorld extends Vue {
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ export default {
|
|||||||
i18n: {
|
i18n: {
|
||||||
languages: [
|
languages: [
|
||||||
{ code: 'it', name: 'Italiano', active: true },
|
{ code: 'it', name: 'Italiano', active: true },
|
||||||
{ code: 'en-us', name: 'English', active: true }
|
{ code: 'en-uk', name: 'English', active: true }
|
||||||
],
|
],
|
||||||
default: 'it',
|
default: 'it',
|
||||||
fallbackTo: 'it'
|
fallbackTo: 'it'
|
||||||
|
|||||||
Reference in New Issue
Block a user