create-chayns-app 1.1.6-beta.0 → 1.1.7

package/.github/workflows/publish.yml

@@ -1,20 +1,20 @@
-name: Publish to NPM
-
-on:
-    workflow_dispatch:
-    release:
-        types: [published]
-
-jobs:
-    build:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v1
-              with:
-                  node-version: '12.19.0'
-                  registry-url: https://registry.npmjs.org/
-            - run: yarn install --immutable
-            - run: yarn publish
-              env:
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+name: Publish to NPM
+
+on:
+    workflow_dispatch:
+    release:
+        types: [published]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v1
+              with:
+                  node-version: '12.19.0'
+                  registry-url: https://registry.npmjs.org/
+            - run: npm install --immutable
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Tobit.Labs™
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2020 Tobit.Labs™
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,180 +1,180 @@
-<div align="center">
-    <h1>
-        <img src="https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/logo.png" width="500px" alt="create-chayns-app" />
-    </h1>
-    <p>Create a new chayns® development project in one command.</p>
-    <div>
-        <a href="https://github.com/TobitSoftware/create-chayns-app/blob/master/LICENSE">
-            <img src="https://img.shields.io/github/license/TobitSoftware/create-chayns-app?style=for-the-badge" alt="" />
-        </a>
-        <a href="https://www.npmjs.com/package/create-chayns-app">
-            <img src="https://img.shields.io/npm/v/create-chayns-app?style=for-the-badge" alt="" />
-        </a>
-        <a href="https://github.com/TobitSoftware/create-chayns-app/commits">
-            <img src="https://img.shields.io/github/last-commit/TobitSoftware/create-chayns-app?style=for-the-badge" alt="" />
-        </a>
-        <a href="https://github.com/TobitSoftware/create-chayns-app/issues">
-            <img src="https://img.shields.io/github/issues-raw/TobitSoftware/create-chayns-app?style=for-the-badge" alt="" />
-        </a>
-    </div>
-    <hr />
-    <img src="https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/demo.gif" alt="Demo of using create-chayns-app">
-</div>
-
-## Overview
-
--   [Get Started](#get-started)
-    -   [Developing a Custom Page](#developing-a-custom-page)
-    -   [Developing a Pagemaker Plugin](#developing-a-pagemaker-plugin)
--   [FAQ](#faq)
-    -   [What is the difference between an Pagemaker plugin and a complete page?](#what-is-the-difference-between-an-pagemaker-plugin-and-a-complete-page)
-    -   [How can I deploy the application so it will be permanently available to all users of my Site?](#how-can-i-deploy-the-application-so-it-will-be-permanently-available-to-all-users-of-my-site)
-
-## Get Started
-
-To bootstrap a new chayns® project, simply run
-
-```bash
-npx create-chayns-app
-```
-
-or
-
-```bash
-yarn create chayns-app
-```
-
-This will start an interactive wizard to guide you through the creation of your
-project.
-
-> A folder will be created in the current working directory of your terminal
-> with the name of your project.
-
-Depending on wether you choose to create a complete page or a pagemaker plugin,
-continue with the ["Developing a Custom Page"](#developing-a-custom-page) or the
-["Developing a Pagemaker Plugin"](#developing-a-pagemaker-plugin) guides
-respectively.
-
-> Don't know what to choose? Check out the
-> [FAQ](#what-is-the-difference-between-an-pagemaker-plugin-and-a-complete-page).
-
-### Developing a Custom Page
-
-Since you chose the `A complete page` option for your project, we will be
-creating a custom page. You can start a local development server by running
-
-```bash
-npm run dev
-```
-
-or
-
-```bash
-yarn dev
-```
-
-You need to develop the project in a chayns-environment for all features to work
-properly. You have to create a Page on a chayns-Site you can manage, if you do
-not have one yet, create one [here](https://chayns.net/).
-
-After finishing the setup of your site, head to **Administration > Content >
-Pages** and click the "Add Page" button at the top.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-page.png)
-
-Choose the "Include website" option and enter a name you like (e.g. "Local
-Development"). Set the source to `http://localhost:1234/`, the address at which
-your local development server operates.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/include-website.png)
-
-Your freshly created page should appear in the menu. Navigate to the page by
-clicking it.
-
-**Congrats!** You are now ready to develop your custom page! Start making
-changes to your code and you should see them reflected on your Page in
-real-time.
-
-### Developing a Pagemaker Plugin
-
-Since you chose the `A pagemaker plugin` option, we will be creating a plugin
-for the Pagemaker, the powerful website editing tool included in chayns.
-
-First you should start the local development server of your project by running
-
-```bash
-npm run dev
-```
-
-or
-
-```bash
-yarn dev
-```
-
-You need to develop the project in a chayns-environment for all features to work
-properly. You have to create a Page on a chayns-Site you can manage, if you do
-not have one yet, create one [here](https://chayns.net/).
-
-After finishing the setup of your site, head to **Administration > Content >
-Pages** and click the "Add Page" button at the top.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-page.png)
-
-Choose the "Create a page" option and enter a name you like (e.g. "Local
-Development"). Click the "Add" button to create the Page.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/create-page.png)
-
-Your freshly created page should appear in the menu. Navigate to the page by
-clicking it. There we want to enter _"admin-mode"_ by activating the switch in
-the main menu, next to the name of your Site.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/admin-switch.png)
-
-A floating button with a big plus sign should appear in the bottom right corner.
-Click it and choose **Interactive > Iframe** in the flyout-menu to add an iframe
-to your Page.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-iframe.png)
-
-Hover over your newly created iframe and activate the chayns-API by clicking on
-the code-symbol and confirming your choice in the dialog.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/iframe-chayns-api.png)
-
-Now we have to set the iframe source (_"Quelle"_) to the address of your local
-development server by tapping on the gear-icon and entering
-`http://localhost:1234/` in the second input field.
-
-![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-local-path.png)
-
-**Congrats!** You are now ready to develop your Pagemaker plugin! Start making
-changes to your code and you should see them reflected on your Page in
-real-time.
-
-## FAQ
-
-### What is the difference between an Pagemaker plugin and a complete page?
-
-A Pagemaker plugin only takes up a slice of your Page and you can add regular
-Pagemaker elements like text, videos, graphics or other interactive elements
-above and below your Plugin, that can be easily edited with the MS Word-like
-interface of the Pagemaker, by anyone, including non-developers.
-
-When developing a complete page, your application will take up all the space on
-one page. On one hand you will have slightly more space to work with, but on the
-other had this means that you cannot easily add content to this page with the
-Pagemaker. Of course you can still add headings (`<h1>`) and other elements in
-your code with HTML, but they will not be easily editable by other people,
-especially non-developers.
-
-### How can I deploy the application so it will be permanently available to all users of my Site?
-
-The most simple way of deploying your app is to use a cloud deployment platform
-like [Vercel](https://vercel.com/home) or [Netlify](https://www.netlify.com/).
-These services will deploy any project for you, aslong as it is managed with a
-Git repository on GitHub or similar services.
-
-If these platforms ask for a build command, enter `chayns-toolkit build` and if
-they ask for a publish directory, enter `build`.
+<div align="center">
+    <h1>
+        <img src="https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/logo.png" width="500px" alt="create-chayns-app" />
+    </h1>
+    <p>Create a new chayns® development project in one command.</p>
+    <div>
+        <a href="https://github.com/TobitSoftware/create-chayns-app/blob/master/LICENSE">
+            <img src="https://img.shields.io/github/license/TobitSoftware/create-chayns-app?style=for-the-badge" alt="" />
+        </a>
+        <a href="https://www.npmjs.com/package/create-chayns-app">
+            <img src="https://img.shields.io/npm/v/create-chayns-app?style=for-the-badge" alt="" />
+        </a>
+        <a href="https://github.com/TobitSoftware/create-chayns-app/commits">
+            <img src="https://img.shields.io/github/last-commit/TobitSoftware/create-chayns-app?style=for-the-badge" alt="" />
+        </a>
+        <a href="https://github.com/TobitSoftware/create-chayns-app/issues">
+            <img src="https://img.shields.io/github/issues-raw/TobitSoftware/create-chayns-app?style=for-the-badge" alt="" />
+        </a>
+    </div>
+    <hr />
+    <img src="https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/demo.gif" alt="Demo of using create-chayns-app">
+</div>
+
+## Overview
+
+-   [Get Started](#get-started)
+    -   [Developing a Custom Page](#developing-a-custom-page)
+    -   [Developing a Pagemaker Plugin](#developing-a-pagemaker-plugin)
+-   [FAQ](#faq)
+    -   [What is the difference between an Pagemaker plugin and a complete page?](#what-is-the-difference-between-an-pagemaker-plugin-and-a-complete-page)
+    -   [How can I deploy the application so it will be permanently available to all users of my Site?](#how-can-i-deploy-the-application-so-it-will-be-permanently-available-to-all-users-of-my-site)
+
+## Get Started
+
+To bootstrap a new chayns® project, simply run
+
+```bash
+npx create-chayns-app
+```
+
+or
+
+```bash
+yarn create chayns-app
+```
+
+This will start an interactive wizard to guide you through the creation of your
+project.
+
+> A folder will be created in the current working directory of your terminal
+> with the name of your project.
+
+Depending on wether you choose to create a complete page or a pagemaker plugin,
+continue with the ["Developing a Custom Page"](#developing-a-custom-page) or the
+["Developing a Pagemaker Plugin"](#developing-a-pagemaker-plugin) guides
+respectively.
+
+> Don't know what to choose? Check out the
+> [FAQ](#what-is-the-difference-between-an-pagemaker-plugin-and-a-complete-page).
+
+### Developing a Custom Page
+
+Since you chose the `A complete page` option for your project, we will be
+creating a custom page. You can start a local development server by running
+
+```bash
+npm run dev
+```
+
+or
+
+```bash
+yarn dev
+```
+
+You need to develop the project in a chayns-environment for all features to work
+properly. You have to create a Page on a chayns-Site you can manage, if you do
+not have one yet, create one [here](https://chayns.net/).
+
+After finishing the setup of your site, head to **Administration > Content >
+Pages** and click the "Add Page" button at the top.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-page.png)
+
+Choose the "Include website" option and enter a name you like (e.g. "Local
+Development"). Set the source to `http://localhost:1234/`, the address at which
+your local development server operates.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/include-website.png)
+
+Your freshly created page should appear in the menu. Navigate to the page by
+clicking it.
+
+**Congrats!** You are now ready to develop your custom page! Start making
+changes to your code and you should see them reflected on your Page in
+real-time.
+
+### Developing a Pagemaker Plugin
+
+Since you chose the `A pagemaker plugin` option, we will be creating a plugin
+for the Pagemaker, the powerful website editing tool included in chayns.
+
+First you should start the local development server of your project by running
+
+```bash
+npm run dev
+```
+
+or
+
+```bash
+yarn dev
+```
+
+You need to develop the project in a chayns-environment for all features to work
+properly. You have to create a Page on a chayns-Site you can manage, if you do
+not have one yet, create one [here](https://chayns.net/).
+
+After finishing the setup of your site, head to **Administration > Content >
+Pages** and click the "Add Page" button at the top.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-page.png)
+
+Choose the "Create a page" option and enter a name you like (e.g. "Local
+Development"). Click the "Add" button to create the Page.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/create-page.png)
+
+Your freshly created page should appear in the menu. Navigate to the page by
+clicking it. There we want to enter _"admin-mode"_ by activating the switch in
+the main menu, next to the name of your Site.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/admin-switch.png)
+
+A floating button with a big plus sign should appear in the bottom right corner.
+Click it and choose **Interactive > Iframe** in the flyout-menu to add an iframe
+to your Page.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-iframe.png)
+
+Hover over your newly created iframe and activate the chayns-API by clicking on
+the code-symbol and confirming your choice in the dialog.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/iframe-chayns-api.png)
+
+Now we have to set the iframe source (_"Quelle"_) to the address of your local
+development server by tapping on the gear-icon and entering
+`http://localhost:1234/` in the second input field.
+
+![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-local-path.png)
+
+**Congrats!** You are now ready to develop your Pagemaker plugin! Start making
+changes to your code and you should see them reflected on your Page in
+real-time.
+
+## FAQ
+
+### What is the difference between an Pagemaker plugin and a complete page?
+
+A Pagemaker plugin only takes up a slice of your Page and you can add regular
+Pagemaker elements like text, videos, graphics or other interactive elements
+above and below your Plugin, that can be easily edited with the MS Word-like
+interface of the Pagemaker, by anyone, including non-developers.
+
+When developing a complete page, your application will take up all the space on
+one page. On one hand you will have slightly more space to work with, but on the
+other had this means that you cannot easily add content to this page with the
+Pagemaker. Of course you can still add headings (`<h1>`) and other elements in
+your code with HTML, but they will not be easily editable by other people,
+especially non-developers.
+
+### How can I deploy the application so it will be permanently available to all users of my Site?
+
+The most simple way of deploying your app is to use a cloud deployment platform
+like [Vercel](https://vercel.com/home) or [Netlify](https://www.netlify.com/).
+These services will deploy any project for you, aslong as it is managed with a
+Git repository on GitHub or similar services.
+
+If these platforms ask for a build command, enter `chayns-toolkit build` and if
+they ask for a publish directory, enter `build`.