gardenjs 0.9.1-alpha.8 → 1.0.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System Info**
+System, Binaries, Browsers
+
+**Additional context**
+E.g. some background/context of how you ran into this bug.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[hello@gardenjs.org](mailto:hello@gardenjs.org?Subject=Linked%20from%20the%20Code%20of%20Conduct).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-present, Robin Danzinger, Martin Farkas - Rabbit Development
+Copyright (c) 2020-present, Robin Danzinger, Martin Farkas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,76 +1,54 @@
-# Component library explorer
-
-Gardenjs is a lightweight UI component explorer for JavaScript front-end libraries that makes it easier to develop, test and document UI components and pages. Svelte, Vue and React are currently supported out of the box. Other libraries can also be easily connected to Garden.
-
-## Why Garden?
-
-- Gardenjs is significantly faster than comparable tools such as Storybook.
-- Gardenjs is multi-framework compatible.
-- Gardenjs has many useful features without being complex and bloated.
-- Gardenjs simply looks good :)
+<p>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="src/client/assets/icons/logo_neg.svg">
+    <img src="src/client/assets/icons/logo.svg">
+  </picture
+</p>
+
+<div>
+  <a href="https://github.com/gardenjs/gardenjs/blob/main/LICENSE.md">
+    <img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License" data-canonical-src="https://img.shields.io/github/license/gardenjs/gardenjs.svg" style="max-width: 100%;">
+  </a>
+  <a href="https://www.npmjs.com/package/gardenjs" target="_blank">
+    <img alt="NPM Version" src="https://img.shields.io/npm/v/gardenjs?color=blue">
+  </a>
+  <a href="https://github.com/gardenjs/gardenjs/actions">
+    <img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/gardenjs/gardenjs/workflow">
+  </a>
+</div>
+
+## The quick and easy alternative
+
+Gardenjs is an open source UI component library explorer for JS frameworks and provides a centralized platform for developers to create, test and present UI components and pages in isolation. Gardenjs promotes modular and reusable code, streamlines collaboration between team members and increases overall productivity. Gardenjs is designed for projects of any size.
+
+Watch the <a href="https://www.gardenjs.org/demo/">demo</a>.
+
+## Why Gardenjs?
+
+- Significantly faster than comparable tools such as Storybook.
+- Simple and efficient working.
+- Many useful features without being complex and bloated.
+- Integration of external libraries within a project.
+- Multiple frameworks running in a single instance.
+- More flexible and extensive work with decorators and hooks.
+- Simply looks good :)
 
 ## Getting Started
 
-Please follow the documentation at [gardenjs.org](https://www.gardenjs.org)
+Please follow the documentation at <a href="https://www.gardenjs.org/docs" target="_blank">gardenjs.org</a>. Happy Gardening!
 
-Happy Gardening :)
+## Supported Frameworks
 
-## Sponsors
-
-Gardenjs is an open source project and is licensed under the MIT license. Become a sponsor to give us more scope for further development. We are grateful for this and will publish your logo and website URL in our README on Github and on our website/documentation.
+HTML snippets are rendered by default. The support of JS frameworks is realized by renderer plugins. There are currently plugins for <a href="https://github.com/gardenjs/render-plugin-svelte" target="_blank">Svelte</a>, <a href="https://github.com/gardenjs/render-plugin-vue" target="_blank">Vue</a> and <a href="https://github.com/gardenjs/render-plugin-react" target="_blank">React</a>. You can also easily create plugins for other frameworks, see the documentation. Contact us, we will be happy to create a repository for your renderer plugin.
 
 ## Contributing
 
-GardenJS was developed and is contributed by [Rabbit Development](https://www.rabbitdevelopment.de). We look forward to your feedback, please report any bugs. We also welcome contributions and are happy about sponsoring.
+Gardenjs was developed and is contributed by <a href="https://www.rabbitdevelopment.com" target="_blank">Rabbit Development</a>. We look forward to your feedback, please report any bugs. We also welcome contributions and are happy about sponsoring.
 
 ## License
 
-[MIT](https://opensource.org/license/mit/)
-
-Copyright (C) 2020 - present by Robin Danzinger & Martin Farkas from [Rabbit Development](https://www.rabbitdevelopment.de).
-
-## Todo´s
-
-### v1.0
-
-- [task] Gardenjs npm modul. (yarn?)
-- [task] Add renderer plugins for svelte, vue. npm modules (@gardenjs/gardenjs-plugin-svelte/vue).
-- [task] Add hooks before, after.
-- [task] Make Gardenjs compatible with React.
-- [task] Add renderer plugin for react. npm modules (@gardenjs/gardenjs-plugin-react).
-- [refactor] Move logic to own file / use stores?. Handle user interaction.
-- [task] Public Gardenjs docs & set Gardenjs repository public.
-- [task] Public Gardenjs demo of Gardenjs docs & set repository of Gardenjs docs public.
-- [task] Public Rabbit Dev website.
-- [task] Create Linkedin profil for Rabbit Dev & Gardenjs.
-
-### v1.1
-
-- [feature] Evaluation of "Make Storybook stories compatible with Garden". If relatively easy possible then development. Otherwise prioritize other tasks/features depending on complexity.
-- [task] Add tests (or v1.1 ?).
-
-### v1.x
-
-- [task] Add [line numbers plugin](https://github.com/wcoder/highlightjs-line-numbers.js) to highlightjs.
-- [task] Sidebarnav is closed by default on narrow display devices.
-- [task] Make setting of default mode possible via garden.config.js.
-- [task] If full mode is active, switching to portrait mode is deactivated.
-- [task] Store selection in panel nav for refresh or if another component is selected.
-- [task] Store selection of stage for refresh or if another component is selected.
-- [task] Make Gardenjs docs link optional via garden.config.js.
-- [task] Show custom favicon.svg configured in garden.config.js.
-- [feature] Screenshot tests:
-  - Docker image oder alternativ for screenshot test.
-  - Automatic create test file & and folder (like init garden).
-  - Settings.
-- [feature] Set width and height of stage by size input.
-- [feature] Add zoom button 100% and if zoomed show size in % with switch possibility.
-- [feature] Vertical dragbar to drag stage horizontical to show rwd behaviour. Already integrated staticly, just needs to be commented out in topbar.svelte: Show 'px' width/height of stage next to rwd-navi.
-- [task] Switch from md to mdx.
-- [feature] Set stagesize values for "mobile, tablet, desktop" inside garden.config.js. Option: Set list of custom values like iPhone 15, iPad, Samsung etc. in garden.config and show dropdown in Gardenjs instead of icons.
-- [task] Integrate Svelte A11y features.
-- [feature] Build kickstarter "carrots". Define components for carrots.
-- [feature] Bookmarks. (siehe ReactCosmos)
-- [feature] Measure.
-
-<br><br><br><p align="center"><img src="src/client/assets/icons/logo.svg"></p>
+[MIT](https://github.com/gardenjs/gardenjs?tab=MIT-1-ov-file#readme)
+
+Copyright (C) 2020-present, Robin Danzinger & Martin Farkas.
+
+<br><br><br><p align="center"><img src="src/client/assets/icons/vegetables.svg"></p>