https://github.com/stimulus-components/stimulus-skeleton

Template for future Stimulus Components' controller
https://github.com/stimulus-components/stimulus-skeleton

stimulus-components stimulusjs

Last synced: about 2 months ago
JSON representation

Template for future Stimulus Components' controller

• Host: GitHub
• URL: https://github.com/stimulus-components/stimulus-skeleton
• Owner: stimulus-components
• License: mit
• Created: 2024-01-04T04:01:48.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-27T17:21:57.000Z (6 months ago)
• Last Synced: 2024-07-29T05:34:42.726Z (about 2 months ago)
• Topics: stimulus-components, stimulusjs
• Language: HTML
• Homepage:
• Size: 252 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stimulus Skeleton

[![](https://img.shields.io/npm/dt/stimulus-skeleton.svg)](https://www.npmjs.com/package/stimulus-skeleton)

[![](https://img.shields.io/npm/v/stimulus-skeleton.svg)](https://www.npmjs.com/package/stimulus-skeleton)

[![](https://github.com/stimulus-components/stimulus-skeleton/workflows/Lint/badge.svg)](https://github.com/stimulus-components/stimulus-skeleton)

[![](https://img.shields.io/github/license/stimulus-components/stimulus-skeleton.svg)](https://github.com/stimulus-components/stimulus-skeleton)

## Getting started

This repo is a template for a future Stimulus Components' controller.

1. Clone this repo

2. Find and rename every occurences of `StimulusSkeleton`, `stimulus-skeleton`, `Skeleton`, `skeleton`, `Stimulus Skeleton` and `TODO`.

3. Adapt the changelog

4. Removing the git folder and `git init` back again.

5. Create the Netlify site.

6. Create the docs on [stimulus-components.com](https://www.stimulus-components.com/).

7. Update Node and dependencies if needed.

## 📚 Documentation

See [stimulus-skeleton documentation](https://www.stimulus-components.com/docs/stimulus-skeleton/).

## 👷‍♂️ Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

## 📝 License

This project is released under the [MIT](http://opensource.org/licenses/MIT) license.