Management system for student clubs
Go to file
Ferdinand Thiessen fca79c36ef [api] Pass Date objects to IsoDateInput validators instead of string. 2021-11-16 23:57:57 +01:00
.vscode [Vue3][pinia] Make pricelist compile with vue3, needs more work! 2021-03-19 16:33:27 +01:00
api [api] Pass Date objects to IsoDateInput validators instead of string. 2021-11-16 23:57:57 +01:00
public [pricelist][picture] update picture if changed, add no-image.svg 2021-03-28 11:34:36 +02:00
src [cleaup] No need for computed if directly derefed 2021-11-16 14:23:18 +01:00
src-cordova [cleanup] Fix some minor formatting 2021-11-11 11:11:06 +01:00
src-electron [cleanup] Fix some minor formatting 2021-11-11 11:11:06 +01: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 [cleaup] No need for computed if directly derefed 2021-11-16 14:23:18 +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 [docs][core] Move devel docs to wiki, use correct api package 2021-05-26 18:49:36 +02:00
babel.config.js new Project with Quasar 2020-10-02 09:13:14 +02:00
package.json [deps] Match dependencies with API 2021-11-16 21:40:56 +01:00
plugin.config.js [docs][core] Move devel docs to wiki, use correct api package 2021-05-26 18:49:36 +02:00
quasar.conf.js [cleanup] Minor style cleanup + use MDIv6 2021-11-11 15:26:57 +01:00
tsconfig.json [core] Seperated all plugins from the main source tree 2021-05-25 16:13:15 +02:00
yarn.lock [deps] FIX require correct version of types package 2021-11-12 10:31:01 +01: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

Installing a plugin

Simply add it as a dependency and install it, for example installing the pricelist-plugin:

yarn add '@flaschengeist/pricelist'
yarn install

Enable / Disable a plugin

After installing a plugin you will have to enable it, this is done by adding it to the plugin.config.js file. For the example above the file should look like:

module.exports = [
  // pricelist plugin:
  '@flaschengeist/pricelist',
];

Remember to rebuild the project

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

Please refer to out development wiki.