Skip to content

Commit

Permalink
adds the folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
afzal442 committed Sep 20, 2023
1 parent 1017fe5 commit 48a8601
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions docs/pages/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 48a8601

Please sign in to comment.