From 48a860123715710cd24cf68d9f862f6f98f21514 Mon Sep 17 00:00:00 2001 From: Afzal Ansari Date: Wed, 20 Sep 2023 16:17:11 +0000 Subject: [PATCH] adds the folder structure --- docs/pages/installation.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/pages/installation.md b/docs/pages/installation.md index 5b11505e8..cc7e724be 100644 --- a/docs/pages/installation.md +++ b/docs/pages/installation.md @@ -36,7 +36,22 @@ While making twists to your application, you can follow along with our getting s ### Manual Installation -To manually create a new app, create a folder e.g. `myapp` and install the required packages: +To manually create a new app, create a new folder e.g. `myapp` so the folder structure would look like below; + +``` +├─ functions (required) +│ ├─ onHello.js +│ └─ ... +├─ lifecycle (optional) +│ ├─ onConnect.js +│ └─ ... +├─ .env (optional) +├─ asyncapi.(yaml | yml | json) (required) +├─ glee.config.js (optional) +├─ package.json (required) +``` + +Install the required packages inside a new folder: ```js npm init -y @@ -106,13 +121,6 @@ export default async function (event) { } } -``` -Finally, create a `.env` file specifying a server name: - -``` -GLEE_SERVER_NAMES=websockets -``` - #### Run the Development Server - Run `npm run dev` to start the development server.