Skip to content

This extension enhances Directus by enabling translations for system emails, ensuring users receive messages in their preferred language. 🌍 With simple installation options, you can quickly integrate it into your Directus setup. 🛠️

Notifications You must be signed in to change notification settings

Mrinal114/mrinal114.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 

Repository files navigation


					layout: default
					title: "This is title"
					description: "This is desc"
					---

Directus Extension for System Email Translation 🌍✉️

GitHub Repo Size GitHub Stars GitHub Forks License

Welcome to the Directus Extension for System Email Translation! This extension helps you translate system emails such as password resets, user registrations, and invitations in Directus CMS. If you are looking to enhance your Directus application with multilingual email capabilities, you are in the right place!

Table of Contents

  1. Features
  2. Installation
  3. Usage
  4. Configuration
  5. Contributing
  6. License
  7. Links

Features

  • Multilingual Support: Easily translate system emails into multiple languages.
  • User-Friendly Interface: Simple setup and configuration through the Directus dashboard.
  • Customizable Templates: Modify email templates to fit your brand’s voice.
  • Seamless Integration: Works smoothly with existing Directus installations.
  • Community Driven: Open-source and community-supported, ensuring continuous improvement.

Installation

To install this extension, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Mrinal114/directus-extension-system-email-i18n.git
  2. Navigate to the cloned directory:

    cd directus-extension-system-email-i18n
  3. Install the required dependencies:

    npm install
  4. Build the extension:

    npm run build
  5. Copy the extension to your Directus extensions folder:

    cp -r ./dist /path/to/directus/extensions/
  6. Restart your Directus server to apply the changes.

Usage

After installation, you can access the extension from the Directus dashboard. Navigate to the "Extensions" section and find the "System Email Translation" option. Here, you can manage translations for different email templates.

Adding Translations

  1. Select the email type you want to translate (e.g., password reset).
  2. Enter the translations for each language you want to support.
  3. Save your changes.

Configuration

You can configure the extension by modifying the config.js file located in the extension's root directory. Here, you can set default languages, email formats, and other preferences.

Example Configuration

module.exports = {
  defaultLanguage: 'en',
  supportedLanguages: ['en', 'es', 'fr'],
  emailTemplates: {
    passwordReset: {
      subject: {
        en: 'Password Reset Request',
        es: 'Solicitud de Restablecimiento de Contraseña',
        fr: 'Demande de Réinitialisation de Mot de Passe',
      },
      body: {
        en: 'Click here to reset your password.',
        es: 'Haga clic aquí para restablecer su contraseña.',
        fr: 'Cliquez ici pour réinitialiser votre mot de passe.',
      },
    },
  },
};

Contributing

We welcome contributions from the community! If you want to help improve this extension, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with clear messages.
  4. Push your branch and submit a pull request.

Your contributions will help make this extension better for everyone!

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Links

For more information, updates, and releases, please visit our Releases page. Here, you can download the latest version and see what’s new.

Download Latest Release

Feel free to check the "Releases" section for any updates or issues. Your feedback is valuable to us, and we appreciate your interest in enhancing Directus with multilingual email capabilities.

Conclusion

Thank you for checking out the Directus Extension for System Email Translation. We hope this tool helps you create a more inclusive experience for your users. Your contributions and feedback are always welcome as we continue to improve this project.

About

This extension enhances Directus by enabling translations for system emails, ensuring users receive messages in their preferred language. 🌍 With simple installation options, you can quickly integrate it into your Directus setup. 🛠️

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published