Skip to content

gnukhata/gkapp

Repository files navigation

version license

GKApp is a Progressive Web App made using Vue & Bootstrap.

  • Free & Open Source under AGPLv3 License
  • PWA/SPA — Single page app
  • Built with Vuejs & Bootstrap Vue
  • SCSS sources with variables

Table of Contents

Description & Demo

Demo Instance

https://try.gnukhata.org

Quick Start

Requirements

  • Nodejs v18.x.x (You could use nvm for managing node versions)

Install

cd to project's dir and run npm install which installs the required dependencies

Development

To pre-compile & hot-reload for development run npm run serve

If you encounter below error like this, Linux/Mac users can export NODE_OPTIONS=--openssl-legacy-provider. more info

If you encounter below error like this, for Windows cmd prompt use set NODE_OPTIONS=--openssl-legacy-provider & Windows powershell use $env:NODE_OPTIONS = "--openssl-legacy-provider. more info

  at FSReqCallback.readFileAfterClose [as oncomplete] (node:internal/fs/read_file_context:68:3) {
  opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ],
  library: 'digital envelope routines',
  reason: 'unsupported',
  code: 'ERR_OSSL_EVP_UNSUPPORTED'
}

To generate the translations: npm run translate-extract & then run npm run translate-compile

vue-getext is the translations library. Link can be found in the Useful Links section below

Build

  • Production-ready with minified bundle npm run build.

Configuration

To customize gkapp, create a new file named .env.local by copying the .env file in this repo and make necessary changes.

License

Gkapp is Licensed under AGPLv3

AGPLv3

Contribution

See CONTRIBUTING.md

Any contribution to the gkapp will be licensed under AGPLv3

Useful Links