Directus Extension Human Readable Id

Overview

The Directus Extension: dwaring87-interface-human-readable-id is a custom interface for generating a human-readable ID for a text or string field in a Directus v9 collection. It allows users to create unique, easily-remembered codes or IDs for their data entries.

Features

• Generates human-readable IDs in the form of {adjective}-{color}-{animal}.
• Allows manual selection of ID components from a list of possible values.
• Supports customization of available options for each component (adjective, color, animal).

Installation

To install the Directus Extension: dwaring87-interface-human-readable-id, follow these steps:

1. Install the node dependencies by running the following command in your Directus instance:

   npm install
   

2. Customize the available options for each ID component (adjective, color, animal) by modifying the files in the src/assets/ directory.

3. Build the extension using rollup via directus-extension:

   npm run build
   

4. Move the dist/index.js file to the directus/extensions/interfaces directory in your Directus instance.

5. Set the DIRECTUS_EXTENSIONS_PATH environment variable to the path of the Directus extensions directory (either directly or by setting it in a .env file in the repository root directory).

6. Use the included deploy script to copy the appropriate files:

   npm run deploy
   

Summary

The Directus Extension: dwaring87-interface-human-readable-id is a useful tool for generating human-readable IDs in Directus v9 collections. It offers flexibility in selecting ID components and allows for customization of available options. By providing easily-remembered codes or IDs, this extension enhances the user experience and improves data organization in Directus.