create-chayns-app 1.3.0-beta.0 → 1.3.0

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.
Files changed (3) hide show
  1. package/README.md +15 -19
  2. package/dist/index.cjs +80 -80
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -75,18 +75,18 @@ yarn dev
75
75
 
76
76
  You need to develop the project in a chayns-environment for all features to work
77
77
  properly. You have to create a Page on a chayns-Site you can manage, if you do
78
- not have one yet, create one [here](https://chayns.net/).
78
+ not have one yet, create one [here](https://chayns.site/).
79
79
 
80
80
  After finishing the setup of your site, head to **Administration > Content >
81
- Pages** and click the "Add Page" button at the top.
81
+ Pages** and choose the "Add Page" option via the floating button in the bottom right corner.
82
82
 
83
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-page.png)
83
+ ![](assets/guide/add-page.png)
84
84
 
85
- Choose the "Include website" option and enter a name you like (e.g. "Local
85
+ Choose the "External website" option and enter a name you like (e.g. "Local
86
86
  Development"). Set the source to `http://localhost:1234/`, the address at which
87
87
  your local development server operates.
88
88
 
89
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/include-website.png)
89
+ ![](assets/guide/create-page.png)
90
90
 
91
91
  Your freshly created page should appear in the menu. Navigate to the page by
92
92
  clicking it.
@@ -117,26 +117,26 @@ properly. You have to create a Page on a chayns-Site you can manage, if you do
117
117
  not have one yet, create one [here](https://chayns.net/).
118
118
 
119
119
  After finishing the setup of your site, head to **Administration > Content >
120
- Pages** and click the "Add Page" button at the top.
120
+ Pages** and choose the "Add Page" option via the floating button in the bottom right corner.
121
121
 
122
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-page.png)
122
+ ![](assets/guide/add-page.png)
123
123
 
124
- Choose the "Create a page" option and enter a name you like (e.g. "Local
124
+ Enter a name you like (e.g. "Local
125
125
  Development"). Click the "Add" button to create the Page.
126
126
 
127
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/create-page.png)
127
+ ![](assets/guide/create-page.png)
128
128
 
129
129
  Your freshly created page should appear in the menu. Navigate to the page by
130
130
  clicking it. There we want to enter _"admin-mode"_ by activating the switch in
131
131
  the main menu, next to the name of your Site.
132
132
 
133
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/admin-switch.png)
133
+ ![](assets/guide/admin-switch.png)
134
134
 
135
135
  A floating button with a big plus sign should appear in the bottom right corner.
136
- Click it and choose **Interactive > Iframe** in the flyout-menu to add an iframe
136
+ Click it and choose **Plugins > Iframe** in the flyout-menu to add an iframe
137
137
  to your Page.
138
138
 
139
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-iframe.png)
139
+ ![](assets/guide/add-iframe.png)
140
140
 
141
141
  Hover over your newly created iframe and activate the chayns-API by clicking on
142
142
  the code-symbol and confirming your choice in the dialog.
@@ -147,7 +147,7 @@ Now we have to set the iframe source (_"Quelle"_) to the address of your local
147
147
  development server by tapping on the gear-icon and entering
148
148
  `http://localhost:1234/` in the second input field.
149
149
 
150
- ![](https://raw.githubusercontent.com/TobitSoftware/create-chayns-app/HEAD/assets/guide/add-local-path.png)
150
+ ![](assets/guide/add-local-path.png)
151
151
 
152
152
  **Congrats!** You are now ready to develop your Pagemaker plugin! Start making
153
153
  changes to your code and you should see them reflected on your Page in
@@ -171,10 +171,6 @@ especially non-developers.
171
171
 
172
172
  ### How can I deploy the application so it will be permanently available to all users of my Site?
173
173
 
174
- The most simple way of deploying your app is to use a cloud deployment platform
175
- like [Vercel](https://vercel.com/home) or [Netlify](https://www.netlify.com/).
176
- These services will deploy any project for you, aslong as it is managed with a
177
- Git repository on GitHub or similar services.
174
+ The simplest way of deploying your app is to build it locally via `chayns-toolkit build` and then upload the build directory in the chayns space of your site.
178
175
 
179
- If these platforms ask for a build command, enter `chayns-toolkit build` and if
180
- they ask for a publish directory, enter `build`.
176
+ There is currently no automated deployment solution for chayns® projects, but we might look into this in the future. Especially during the process of improving our online IDE and the consistency between the local development environment and the online IDE.