@reveldigital/gadgetizer 1.0.8 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -71,6 +71,7 @@ The Gadgetizer tool performs the following actions based on your project type:
|
|
|
71
71
|
After running the tool, your project will have:
|
|
72
72
|
|
|
73
73
|
- 📄 `gadget.yaml` - Gadget configuration file
|
|
74
|
+
- 📄 `deploy-to-pages.yml` (optional) - GitHub Actions workflow for automatic deployment to GitHub Pages
|
|
74
75
|
- 📦 Updated `package.json` with Revel Digital dependencies
|
|
75
76
|
- 🛠️ `build:gadget` npm script for regenerating the gadget XML
|
|
76
77
|
- 🗂️ Generated XML file in your build/dist directory
|
|
@@ -101,12 +102,36 @@ prefs:
|
|
|
101
102
|
|
|
102
103
|
Edit this file to customize your gadget's properties and user preferences.
|
|
103
104
|
|
|
105
|
+
### Working with Preferences
|
|
106
|
+
|
|
107
|
+
Preferences defined in the `prefs` section become configurable options in the Revel Digital CMS, allowing end users to customize your gadget's behavior and appearance. You can access these preferences in your application code using the Revel Digital client SDK.
|
|
108
|
+
|
|
109
|
+
For detailed information about accessing preferences and using the client SDK in your gadget, see the [client SDK documentation](https://www.npmjs.com/package/@reveldigital/client-sdk).
|
|
110
|
+
|
|
111
|
+
## 🚀 GitHub Pages Deployment (Optional)
|
|
112
|
+
|
|
113
|
+
The `deploy-to-pages.yml` file is an optional GitHub Actions workflow that provides automated building and deployment of your gadget to GitHub Pages. When placed in your project's `.github/workflows/` directory, this workflow will:
|
|
114
|
+
|
|
115
|
+
- **Automatically trigger** on pushes to your main branch
|
|
116
|
+
- **Build your project** using your existing build commands
|
|
117
|
+
- **Run the Gadgetizer** to generate the XML configuration
|
|
118
|
+
- **Deploy the result** to GitHub Pages for easy hosting and testing
|
|
119
|
+
|
|
120
|
+
To use this feature:
|
|
121
|
+
|
|
122
|
+
1. Copy `deploy-to-pages.yml` to `.github/workflows/` in your project
|
|
123
|
+
2. Customize the build commands for your specific project type
|
|
124
|
+
3. Ensure GitHub Pages is enabled in your repository settings
|
|
125
|
+
4. Push changes to your main branch to trigger automatic deployment
|
|
126
|
+
|
|
127
|
+
This makes it easy to share and test your gadgets with others by providing a publicly accessible URL.
|
|
128
|
+
|
|
104
129
|
## 🛠️ Supported Frameworks
|
|
105
130
|
|
|
106
|
-
- **Angular** - Uses the official Revel Digital Angular schematic
|
|
107
|
-
- **React** - Instruments with client SDK and generates gadget configuration
|
|
108
|
-
- **Vue** - Instruments with client SDK and generates gadget configuration
|
|
109
|
-
- **Vanilla JavaScript** - Instruments with client SDK and generates gadget configuration
|
|
131
|
+
- **Angular** - Uses the official Revel Digital Angular schematic.
|
|
132
|
+
- **React** - Instruments with client SDK and generates gadget configuration. [Sample Project](https://github.com/RevelDigital/gadget-demo-react)
|
|
133
|
+
- **Vue** - Instruments with client SDK and generates gadget configuration. [Sample Project](https://github.com/RevelDigital/gadget-demo-vue)
|
|
134
|
+
- **Vanilla JavaScript** - Instruments with client SDK and generates gadget configuration.
|
|
110
135
|
|
|
111
136
|
## 📚 Revel Digital Client SDK
|
|
112
137
|
|