https://github.com/nerkarso/directus-extensions
Collection of Directus extensions
https://github.com/nerkarso/directus-extensions
directus directus-extension
Last synced: 21 days ago
JSON representation
Collection of Directus extensions
- Host: GitHub
- URL: https://github.com/nerkarso/directus-extensions
- Owner: nerkarso
- Created: 2022-09-20T22:43:53.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T04:51:25.000Z (over 1 year ago)
- Last Synced: 2024-04-14T10:15:44.071Z (over 1 year ago)
- Topics: directus, directus-extension
- Language: TypeScript
- Homepage:
- Size: 762 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Directus Extensions
Collection of Directus extensions.
## Available Extensions
### Bundles
- [SweetAlert](bundles/sweetalert/README.md)
### Displays
- [Date Formatter](displays/date-formatter/README.md)
### Endpoints
- [File Preview](endpoints/file-preview/README.md)
### Hooks
- [Current Role](hooks/current-role/README.md)
### Interfaces
- [Spacer](interfaces/spacer/README.md)
### Operations
- [Firebase Messaging](operations/firebase-messaging/README.md)
- [Mailer](operations/mailer/README.md)
### Themes
- [Sleek Dark](themes/sleek-dark/README.md)
## Installation
1. Open the terminal in your Directus project.
2. Install the extension:
```sh
npm install directus-extension-
```
## Creating
The easiest way to start developing extensions is to use the `create-directus-extension` utility:
```sh
pnpx create-directus-extension
```
After specifying the name of the extension, the type of the extension and the programming language you want to use, the utility will create a folder with the recommended file structure to create an extension.
## Developing
Use the `watch` script when developing your extension because it rebuilds your source code whenever a file has changed.
```sh
pnpm watch
```
## Building
Before your extension can be used by Directus, it has to be built. If you used the `create-directus-extension` utility to scaffold your extension, building your extension is as easy as running:
```sh
pnpm build
```
## Publishing
1. Increment the version number in the `package.json` file.
2. Build the package:
```sh
pnpm build
```
3. Publish the package:
```sh
npm publish --access=public
```
## License
[MIT License](LICENSE)