create-outsystems-astro 0.1.0 → 0.2.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.
- package/README.md +7 -3
- package/package.json +3 -2
- package/template/.gitignore +27 -0
- package/template/astro.config.mjs +5 -2
- package/template/package-lock.json +1134 -107
- package/template/package.json +3 -2
- package/template/src/pages/{counter.astro → counter-react.astro} +5 -2
- package/template/src/pages/counter-vue.astro +14 -0
- package/template/src/{components → react/components}/Counter.tsx +3 -3
- package/template/src/vue/components/Counter.vue +47 -0
- package/template/tsconfig.json +1 -1
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
Generates [Astro Islands](https://docs.astro.build/en/concepts/islands/) for use in OutSystems that can create self contained interactive code elements from different frameworks. It allows an extension of the front-end with these dynamic libraries.
|
|
3
3
|
|
|
4
4
|
## When to use this library
|
|
5
|
-
- Custom interactive elements that would
|
|
5
|
+
- Custom interactive elements that would be difficult/not possible to build directly in OutSystems.
|
|
6
6
|
- Wrappers around interactive elements built in other front-end frameworks.
|
|
7
|
-
- Direct migration of traditional code.
|
|
7
|
+
- Direct migration of external traditional code.
|
|
8
8
|
|
|
9
9
|
## When NOT to use this library
|
|
10
10
|
- You will most likely not need to use this library for most of the front-end development. This is similar in use to the custom code development in for the back-end in [O11](https://success.outsystems.com/documentation/11/integration_with_external_systems/extend_logic_with_your_own_code/) and [ODC](https://success.outsystems.com/documentation/outsystems_developer_cloud/building_apps/extend_your_apps_with_custom_code/).
|
|
@@ -12,7 +12,8 @@ Generates [Astro Islands](https://docs.astro.build/en/concepts/islands/) for use
|
|
|
12
12
|
- Loading performance of component must be instant. The Astro Island will load after the page/screen has loaded since the initializer and tag will be loaded after.
|
|
13
13
|
|
|
14
14
|
## Current supported frameworks
|
|
15
|
-
- [React](https://docs.astro.build/en/guides/integrations-guide/react/)
|
|
15
|
+
- [React](https://docs.astro.build/en/guides/integrations-guide/react/)
|
|
16
|
+
- [Vue](https://docs.astro.build/en/guides/integrations-guide/vue/)
|
|
16
17
|
|
|
17
18
|
## Getting started
|
|
18
19
|
Run the Create OutSystems Astro generator:
|
|
@@ -65,6 +66,9 @@ All commands are run from the root of the project, from a terminal:
|
|
|
65
66
|
| `npm run astro -- --help` | Get help using the Astro CLI |
|
|
66
67
|
|
|
67
68
|
|
|
69
|
+
## Getting Started
|
|
70
|
+
Delete the demo application under the ```src``` flder and choose your framework(s) to build the components in.
|
|
71
|
+
|
|
68
72
|
## Converting to OutSystems
|
|
69
73
|
|
|
70
74
|
Once development is complete, run:
|
package/package.json
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-outsystems-astro",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.2.0",
|
|
5
5
|
"description": "Create an OutSystems Astro Island project to import as a component into your OutSystems application",
|
|
6
6
|
"bin": {
|
|
7
7
|
"create-outsystems-astro": "bin/cli.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"bin",
|
|
11
|
-
"template"
|
|
11
|
+
"template",
|
|
12
|
+
"template/.gitignore"
|
|
12
13
|
],
|
|
13
14
|
"publishConfig": {
|
|
14
15
|
"access": "public"
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# build output
|
|
2
|
+
dist/
|
|
3
|
+
# generated types
|
|
4
|
+
.astro/
|
|
5
|
+
|
|
6
|
+
# dependencies
|
|
7
|
+
node_modules/
|
|
8
|
+
|
|
9
|
+
# logs
|
|
10
|
+
npm-debug.log*
|
|
11
|
+
yarn-debug.log*
|
|
12
|
+
yarn-error.log*
|
|
13
|
+
pnpm-debug.log*
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
# environment variables
|
|
17
|
+
.env
|
|
18
|
+
.env.production
|
|
19
|
+
|
|
20
|
+
# macOS-specific files
|
|
21
|
+
.DS_Store
|
|
22
|
+
|
|
23
|
+
# jetbrains setting folder
|
|
24
|
+
.idea/
|
|
25
|
+
|
|
26
|
+
# output folder
|
|
27
|
+
output/
|
|
@@ -3,9 +3,12 @@ import react from '@astrojs/react';
|
|
|
3
3
|
import { defineConfig } from 'astro/config';
|
|
4
4
|
|
|
5
5
|
|
|
6
|
+
import vue from '@astrojs/vue';
|
|
7
|
+
|
|
8
|
+
|
|
6
9
|
// https://astro.build/config
|
|
7
10
|
export default defineConfig({
|
|
8
|
-
integrations: [react()],
|
|
11
|
+
integrations: [react(), vue()],
|
|
9
12
|
build: {
|
|
10
13
|
inlineStylesheets: 'always'
|
|
11
14
|
},
|
|
@@ -26,4 +29,4 @@ export default defineConfig({
|
|
|
26
29
|
},
|
|
27
30
|
},
|
|
28
31
|
},
|
|
29
|
-
});
|
|
32
|
+
});
|