From 7fb689b31fca185eb6af58f118f48fe6cafb710b Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Fri, 2 Apr 2021 04:41:49 +0200 Subject: [PATCH] [core] Added license and fixed links in package.json --- LICENSE | 21 +++++++++++++++++++++ README.md | 14 +++++++++----- package.json | 29 +++++++++++++++++------------ quasar.conf.js | 4 ++-- yarn.lock | 10 +++++----- 5 files changed, 54 insertions(+), 24 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bbcaf76 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright 2021 Tim Gröger | Flaschengeist Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index e747fa0..67675aa 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,21 @@ # Flaschengeist (flaschengeist-frontend) -Dynamischen Managementsystem für Studentenclubs +Modular student club administration system. +Licensed under the MIT license. ## Install the dependencies + ```bash yarn install ``` ## Plugins + ### Build a Plugin + A Flaschengeist-Frontend-Plugin should be placed in `src/plugins`. It needs a `plugin.ts` File which exports a plugin with the following interface: + ``` name: string; mainRoutes?: PluginRouteConfig[]; @@ -28,20 +33,19 @@ You can activate and deactive Plugins in `src/boot/plugins.ts`. You have to set The order of the plugins is importend! ### Start the app in development mode (hot-code reloading, error reporting, etc.) + ```bash yarn quasar dev ``` ### Lint the files + ```bash yarn run lint ``` ### Build the app for production + ```bash yarn quasar build ``` - diff --git a/package.json b/package.json index 8a02bec..90ab217 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,15 @@ { - "name": "flaschengeist-frontend", - "version": "0.1.0-alpha.1", - "description": "Dynamischen Managementsystem für Studentenclubs", - "productName": "Flaschengeist", - "author": "Tim Gröger ", "private": true, + "license": "MIT", + "version": "2.0.0-alpha.1", + "productName": "Flaschengeist", + "name": "flaschengeist-frontend", + "author": "Tim Gröger ", + "homepage": "https://flaschengeist.dev/Flaschengeist", + "description": "Modular student club administration system", + "bugs": { + "url" : "https://flaschengeist.dev/Flaschengeist/flaschengeist-frontend/issues" + }, "scripts": { "format": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'", "lint": "eslint --ext .js,.ts,.vue ./src" @@ -15,15 +20,9 @@ "pinia": "^2.0.0-alpha.10", "quasar": "^2.0.0-beta.11" }, - "prettier": { - "singleQuote": true, - "semi": true, - "printWidth": 100, - "arrowParens": "always" - }, "devDependencies": { "@quasar/app": "^3.0.0-beta.10", - "@quasar/extras": "^1.10.1", + "@quasar/extras": "^1.10.2", "@quasar/quasar-app-extension-qcalendar": "file:deps/quasar-ui-qcalendar/app-extension", "@types/node": "^12.20.7", "@types/webpack": "^4.41.27", @@ -37,6 +36,12 @@ "prettier": "^2.2.1", "typescript": "^4.2.3" }, + "prettier": { + "singleQuote": true, + "semi": true, + "printWidth": 100, + "arrowParens": "always" + }, "browserslist": [ "last 10 Chrome versions", "last 10 Firefox versions", diff --git a/quasar.conf.js b/quasar.conf.js index 4fe8d42..d3f360e 100644 --- a/quasar.conf.js +++ b/quasar.conf.js @@ -38,7 +38,7 @@ module.exports = configure(function (/* ctx */) { // https://github.com/quasarframework/quasar/tree/dev/extras extras: [ // 'ionicons-v4', - 'mdi-v5', + // 'mdi-v5', // 'fontawesome-v5', // 'eva-icons', // 'themify', @@ -134,7 +134,7 @@ module.exports = configure(function (/* ctx */) { manifest: { name: 'Flaschengeist', short_name: 'Flaschengeist', - description: 'Dynamischen Managementsystem für Studentenclubs', + description: 'Modular student club administration system', display: 'standalone', orientation: 'portrait', background_color: '#ffffff', diff --git a/yarn.lock b/yarn.lock index 4fd5820..1ee67e0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1142,10 +1142,10 @@ core-js "^3.6.5" core-js-compat "^3.6.5" -"@quasar/extras@^1.10.1": - version "1.10.1" - resolved "https://registry.yarnpkg.com/@quasar/extras/-/extras-1.10.1.tgz#ff771b9af3849d5b8726d4b6914a052e7e540ef0" - integrity sha512-gVcrUhdLGNeWXRhTfsaK4AeSKnj3zWQ6wtVlmrxmoNbHtaP/U33c4XgQUb3XglRn0UA0FVOa3avBsc2AVq3CYA== +"@quasar/extras@^1.10.2": + version "1.10.2" + resolved "https://registry.yarnpkg.com/@quasar/extras/-/extras-1.10.2.tgz#8992bac8f94a077494ee4fae653729a3a5a47e6f" + integrity sha512-S5aE/If4Bgl6qAoHqDZcVw6GxeNpksix3N1dp8k3YPMniIaoU/BLACeQYnrGkn3ffZ1+5JzF0teAE3no6WGzEg== "@quasar/fastclick@1.1.4": version "1.1.4" @@ -1155,7 +1155,7 @@ "@quasar/quasar-app-extension-qcalendar@file:deps/quasar-ui-qcalendar/app-extension": version "4.0.0-alpha.1" dependencies: - "@quasar/quasar-ui-qcalendar" "link:../../../../../.cache/yarn/v6/npm-@quasar-quasar-app-extension-qcalendar-4.0.0-alpha.1-78666470-f0b2-4a81-b85b-52fbc7ca1b4c-1617303049888/node_modules/@quasar/ui" + "@quasar/quasar-ui-qcalendar" "link:../../../../../.cache/yarn/v6/npm-@quasar-quasar-app-extension-qcalendar-4.0.0-alpha.1-17214bff-79ad-4831-9a4c-83ead3c678d9-1617331124106/node_modules/@quasar/ui" "@quasar/quasar-ui-qcalendar@link:deps/quasar-ui-qcalendar/ui": version "0.0.0"