https://github.com/druxt/module-template

A template for creating custom Druxt modules.
https://github.com/druxt/module-template

druxt module template

Last synced: 2 months ago
JSON representation

A template for creating custom Druxt modules.

• Host: GitHub
• URL: https://github.com/druxt/module-template
• Owner: druxt
• Created: 2022-02-14T01:17:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T16:55:12.000Z (4 months ago)
• Last Synced: 2024-09-16T20:46:37.383Z (4 months ago)
• Topics: druxt, module, template
• Language: PHP
• Homepage:
• Size: 153 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• drupal-js - DruxtModule (template)

README

        
# DruxtModule (template)

[![CI](https://github.com/druxt/module-template/actions/workflows/ci.yml/badge.svg)](https://github.com/druxt/module-template/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/druxt/module-template/branch/main/graph/badge.svg?token=TwCLJOKEjm)](https://codecov.io/gh/druxt/module-template)

> This is a template for creating a DruxtJS module.

## Links

- DruxtJS: https://druxtjs.org

- Community Discord server: https://discord.druxtjs.org

## Getting started

1. **Use this template**

    Click the **Use this template** button in GitHub and follow the on-screen instructions to **Create a new repository**.

2. **Build, dev, test, commit**

    This repository is setup with for development using the following tools:

    - [Siroc](https://github.com/unjs/siroc): `npm run build`

    - [Jest](https://jestjs.io/): `npm test`

    - Linting tools: `npm run lint`

    - [Changesets](https://github.com/changesets/changesets): `npm run changesets`

3. **Contribute**

    Have a module you want to share with the Druxt community? Let us know via the [Community Discord server](https://discord.druxtjs.org).