From 22f47bd34ecf6b4958af6085fc60b99a4658d5da Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Wed, 26 May 2021 18:49:36 +0200 Subject: [PATCH] [docs][core] Move devel docs to wiki, use correct api package --- README.md | 59 +----------------------------------------------- api/package.json | 7 +++--- package.json | 11 ++++----- plugin.config.js | 6 ++--- quasar.conf.js | 5 ++-- 5 files changed, 13 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 844f5c4..4b5b4f8 100644 --- a/README.md +++ b/README.md @@ -76,61 +76,4 @@ yarn quasar build ## Development -### Icons used - -We are using the `mdi-v5` icon set, so feel free to use any icon from it. -A list can be found [here](https://materialdesignicons.com/) - -### Commands useful for development - -#### Start the app in development mode - -Provides hot-code reloading, error reporting, etc. - -```bash -yarn quasar dev -``` - -#### File linting - -```bash -yarn run lint -``` - -### Plugins - -#### Build a Plugin - -Create a new node.js project and add `@flaschengeist/api` as a peer dependency (e.g. `yarn add --peer '@flaschengeist/api'`). -If your plugin depends on an other plugin (e.g. you use the `@flaschengeist/users` plugin / stores), -then you have to add that plugin as a peer dependency too. - -You need to define a main entry point for your plugin (e.g. `"main": "src/index.ts"` in your `package.json`) which exportes -a plugin descriptor as the default export (see `@flaschengeist/types` -> `FG_Plugin.Plugin`). -E.g. - -```ts -import { FG_Plugin } from '@flaschengeist/types'; -import { routes } from './routes'; - -const plugin: FG_Plugin.Plugin = { - id: 'com.example.myplugin', - name: 'myplugin', - innerRoutes: routes, - // This are required backend plugins: - requiredModules: [['auth'], ['users'], ['roles']], - version: '0.0.1', - widgets: [ - { - priority: 1, - name: 'greeting', - permissions: [], - widget: defineAsyncComponent(() => import('./components/Widget.vue')), - }, - ], -}; - -export default plugin; -``` - -This will add a plugin providing a widget for the dashboard side and some routes. +Please refer to out [development wiki](https://flaschengeist.dev/Flaschengeist/flaschengeist/wiki/Development). diff --git a/api/package.json b/api/package.json index 3b26079..cbe07a7 100644 --- a/api/package.json +++ b/api/package.json @@ -1,5 +1,4 @@ { - "private": true, "license": "MIT", "version": "1.0.0-alpha.1", "name": "@flaschengeist/api", @@ -7,7 +6,7 @@ "homepage": "https://flaschengeist.dev/Flaschengeist", "description": "Modular student club administration system", "bugs": { - "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-frontend/issues" + "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist/issues" }, "scripts": { "format": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'", @@ -20,7 +19,7 @@ "pinia": "^2.0.0-alpha.19" }, "devDependencies": { - "@flaschengeist/types": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-types.git#develop", + "@flaschengeist/types": "^1.0.0-alpha.1", "@types/node": "^12.20.13", "@typescript-eslint/eslint-plugin": "^4.24.0", "@typescript-eslint/parser": "^4.24.0", @@ -34,7 +33,7 @@ "prettier": { "singleQuote": true, "semi": true, - "printWidth": 100, + "printWidth": 120, "arrowParens": "always" } } diff --git a/package.json b/package.json index 5257c5e..84a747d 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "homepage": "https://flaschengeist.dev/Flaschengeist", "description": "Modular student club administration system", "bugs": { - "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-frontend/issues" + "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist/issues" }, "scripts": { "format": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'", @@ -16,17 +16,14 @@ }, "dependencies": { "@flaschengeist/api": "file:./api", - "@flaschengeist/users": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-users.git#develop", - "@flaschengeist/schedule": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-schedule.git#develop", - "@flaschengeist/balance": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-balance.git#develop", - "@flaschengeist/pricelist": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-pricelist.git#develop", + "@flaschengeist/users": "^1.0.0-alpha.1", "axios": "^0.21.1", "cordova": "^10.0.0", "pinia": "^2.0.0-alpha.19", "quasar": "^2.0.0-beta.18" }, "devDependencies": { - "@flaschengeist/types": "git+https://flaschengeist.dev/ferfissimo/flaschengeist-types.git#develop", + "@flaschengeist/types": "^1.0.0-alpha.1", "@quasar/app": "^3.0.0-beta.26", "@quasar/extras": "^1.10.4", "@types/node": "^12.20.13", @@ -46,7 +43,7 @@ "prettier": { "singleQuote": true, "semi": true, - "printWidth": 100, + "printWidth": 120, "arrowParens": "always" }, "browserslist": [ diff --git a/plugin.config.js b/plugin.config.js index af382d3..91d11af 100644 --- a/plugin.config.js +++ b/plugin.config.js @@ -1,6 +1,6 @@ // You can add your plugins here module.exports = [ - '@flaschengeist/balance', - '@flaschengeist/schedule', - '@flaschengeist/pricelist', +// '@flaschengeist/balance', +// '@flaschengeist/schedule', +// '@flaschengeist/pricelist', ] diff --git a/quasar.conf.js b/quasar.conf.js index 9df2259..ef7aee5 100644 --- a/quasar.conf.js +++ b/quasar.conf.js @@ -15,7 +15,6 @@ const { configure } = require('quasar/wrappers') module.exports = configure(function (/* ctx */) { return { - // https://quasar.dev/quasar-cli/supporting-ts // https://quasar.dev/quasar-cli/supporting-ts supportTS: { tsCheckerConfig: { @@ -55,7 +54,7 @@ module.exports = configure(function (/* ctx */) { build: { vueRouterMode: 'history', // available values: 'hash', 'history' - // transpile: false,// eslint-disable-next-line + // transpile: false, // Add dependencies for transpiling with Babel (Array of string/regex) @@ -63,7 +62,7 @@ module.exports = configure(function (/* ctx */) { // Applies only if "transpile" is set to true. // transpileDependencies: [], - // rtl: false, // https://quasa// eslint-disable-next-line + // rtl: false, // analyze: true,