Update Readme
This commit is contained in:
parent
caedb5a9d2
commit
555d2a871b
23
README.md
23
README.md
|
@ -7,6 +7,26 @@ Dynamischen Managementsystem für Studentenclubs
|
|||
npm 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[];
|
||||
outRoutes?: PluginRouteConfig[];
|
||||
store?: Map<string, Module<any, StateInterface>>;
|
||||
requiredModules: string[];
|
||||
version: string;
|
||||
```
|
||||
|
||||
You have to import `FG_Plugin` from `plugins.d.ts`.
|
||||
|
||||
### Configure Plugin
|
||||
|
||||
You can activate and deactive Plugins in `src/boot/plugins.ts`. You have to set the name of the Plugin into `config.loadModules`.
|
||||
The order of the plugins is importend!
|
||||
|
||||
### Start the app in development mode (hot-code reloading, error reporting, etc.)
|
||||
```bash
|
||||
quasar dev
|
||||
|
@ -21,6 +41,7 @@ npm run lint
|
|||
```bash
|
||||
quasar build
|
||||
```
|
||||
|
||||
<!--
|
||||
### Customize the configuration
|
||||
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
|
||||
-->
|
||||
|
|
Loading…
Reference in New Issue