fix: improve glee default template (#946)

Co-authored-by: Lukasz Gornicki <[email protected]>%0ACo-authored-by: souvik <[email protected]>

.gitignore

@@ -26,3 +26,9 @@ spec-examples.zip
 # Coverage for testing
 
 coverage
+
+# Glee
+assets/create-glee-app/templates/default/.glee
+assets/create-glee-app/templates/tutorial/.glee
+assets/create-glee-app/templates/default/docs
+assets/create-glee-app/templates/tutorial/docs

assets/create-glee-app/templates/default/README-template.md

@@ -2,12 +2,26 @@ This is a [Glee](https://github.com/asyncapi/glee) project bootstrapped with the
 
 ## Getting Started
 
-First, run the development server:
+1) Install Dependencies:
+
+```bash
+npm install --ignore-scripts
+```
+
+
+
+2) run the development server:
 
 ```bash
 npm run dev
 ```
 
+3) send some text to the websocket server at `ws://0.0.0.0:3000/hello`
+
+```bash
+websocat ws://0.0.0.0:3000/hello
+Hi!
+```
 You can start editing the API by modifying `functions/onHello.js` and `asyncapi.yaml`. The server auto-updates as you edit the file.
 
 ## Learn More

assets/create-glee-app/templates/default/asyncapi.yaml

@@ -8,7 +8,7 @@ servers:
     protocol: ws
 channels:
   hello:
-    address: hello
+    address: /hello
     messages:
       hello:
         $ref: '#/components/messages/hello'
@@ -17,11 +17,12 @@ operations:
     action: receive
     channel:
       $ref: '#/channels/hello'
-    reply:
-      channel:
-        $ref: '#/channels/hello'
+  sendHello:
+    action: send
+    channel:
+      $ref: '#/channels/hello'
 components:
   messages:
     hello:
       payload:
-        type: string
+        type: string

assets/create-glee-app/templates/default/functions/onHello.ts

@@ -0,0 +1,11 @@
+import { GleeFunctionReturn } from "@asyncapi/glee"
+
+export default async function (event): Promise<GleeFunctionReturn> {  
+  return {
+    send: [{
+      payload: `Hello from Glee! You said: '${event.payload}'.`,
+      channel: "hello",
+      server: "websockets"
+    }]
+  }
+}