README.md

directus-display-qrcode

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Compile it yourself
   • Install the precompiled Extension
3. Roadmap
4. License
5. Contact

About The Project

This is a simple Directus 9 Display Extension, which allows to display QR-Codes directly inside of the Directus UI. It takes a String input and renders a QR-Code when hovering over the String Value in the Collection overview.

To display the QR-Code on the Collection Editing Page, check out directus-interface-qrcode.

Built With

• Vue
• qrcode.vue
• SASS

Getting Started

There are 2 ways to get up and running. Either you compile the Extension yourself, or you download the precompiled Extension:

Compile it yourself

1. Clone the repo

 git clone https://github.com/K3-Network/directus-display-qrcode.git

2. Install NPM packages

   npm install

3. Compile the Extension

   npx directus-extension build

4. Copy the directus-display-qrcode\dist\index.js into your Directus Installation: Your-Directus-Installation\extensions\displays\directus-display-qrcode\index.js

5. Restart Directus

Install the precompiled Extension

1. Download the Binaries

2. Extract the ZIP into Your-Directus-Installation\extensions\displays\

3. Restart Directus

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the ISC License. See LICENSE for more information.

Contact

Nicolas Mierbach - K3.Network

Project Link: https://github.com/K3-Network/directus-display-qrcode