Management system for student clubs https://flaschengeist.dev
Go to file
groegert f2b7f3a3b4 [core] call api.delete(`auth/${token}`) within a valid session
fixes: #7
2021-05-21 10:17:56 +02:00
.vscode [Vue3][pinia] Make pricelist compile with vue3, needs more work! 2021-03-19 16:33:27 +01:00
public [pricelist][picture] update picture if changed, add no-image.svg 2021-03-28 11:34:36 +02:00
src [core] call api.delete(`auth/${token}`) within a valid session 2021-05-21 10:17:56 +02:00
src-cordova [pricelist][electron] add electron 2021-04-17 12:36:19 +02:00
src-electron [pricelist][electron] add electron 2021-04-17 12:36:19 +02:00
.editorconfig new Project with Quasar 2020-10-02 09:13:14 +02:00
.eslintignore Use yarn and updated dependencies 2020-11-24 17:34:12 +01:00
.eslintrc.js Fixed dependencies, calendar and submodule 2021-03-19 15:53:25 +01:00
.gitignore Code formatting with prettier 2021-01-28 23:08:34 +01:00
.postcssrc.js new Project with Quasar 2020-10-02 09:13:14 +02:00
LICENSE [core] Added license and fixed links in package.json 2021-04-02 04:41:49 +02:00
README.md [core] added some hints to ease the initial development setup 2021-05-20 16:27:40 +00:00
babel.config.js new Project with Quasar 2020-10-02 09:13:14 +02:00
package.json [core][plugin] Fixed compatibility with Pinia 2021-05-20 20:31:37 +02:00
quasar.conf.js [core] Revert usage of material icons and use mdi-v5 2021-04-02 22:31:07 +02:00
quasar.extensions.json Finished Basic Calendar Week Functionality 2021-02-06 00:07:58 +01:00
tsconfig.json [Vue3] Fixed some more error and merge issues 2021-03-19 15:25:22 +01:00
yarn.lock [core][plugin] Fixed compatibility with Pinia 2021-05-20 20:31:37 +02:00

README.md

Flaschengeist (frontend)

Modular student club administration system, licensed under the MIT license.

Installation

Requirements

 "engines": {
    "node": ">= 12.22.1",
    "npm": ">= 6.14.12",
    "yarn": ">= 1.21.1"
 }

So on debian (buster and bullseye) you will need to install node.js and yarn beside the debian packages to meet the needed versions.

pushd ~/opt
wget https://nodejs.org/dist/v16.2.0/node-v16.2.0-linux-x64.tar.xz
tar -xJf node-v16.2.0-linux-x64.tar.xz
export PATH="$(pwd)/node-v16.2.0-linux-x64/bin":"$PATH"
npm i -g yarn
npm i -g @quasar/cli
popd

Install the dependencies

yarn install

Be aware npm might not work.

Configure Plugins

You can activate and deactive Plugins in src/boot/plugins.ts. You have to set the name of the Plugin into config.loadModules.

Configure Backend

The application is using the API of the backend This access needs to be configured in `src/config.ts'->config.baseURL

  • either you do have a proxy webserver that maps the '/api' to the backend (http://localhost:5000) or
  • you do directly configure the backend there:baseURL: 'http://localhost:5000'. Be aware not committing this configuration.

Build the application

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

Commands useful for development

Start the app in development mode

Provides hot-code reloading, error reporting, etc.

yarn quasar dev

File linting

yarn run lint

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[];
requiredModules: string[];
version: string;

You have to import FG_Plugin from plugins.d.ts.