Skip to content

Commit

Permalink
docs: update doc
Browse files Browse the repository at this point in the history
Signed-off-by: sarthakjdev <[email protected]>
  • Loading branch information
sarthakjdev committed Jun 5, 2024
1 parent d7b9012 commit daf9864
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 38 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: 'Setting up Wapi.js Application Development Environment'
---


## Initiating a Wapi.js project

### Chat bot

The first step to build a wapi.js based chat bot is to create a new node.js project. You can quickly setup a new project using the utility NPM package provided with the wapi.js SDK only, run the following command in your terminal to setup the project:

```bash
pnpm create-wapi-app my-whatsapp-bot
```

<Check>Once you run this command, you would be asked a couple of questions like the name of the project and whether you want to use typescript or javascript for this project. Once you answer them, you project will start to setup and once done. You can navigate to the project directory and start building your chat bot.</Check>

### Other use cases


- You are a developer and want to integrate the whatsapp business API with your existing backend.
- You are a solution partner or a tech partner with WhatsApp and want to access the WhatsApp business API to build a solution for your clients.

To do so, you can install the wapi.js SDK using the following command:

<Tabs>
<Tab title="pnpm">
```bash
pnpm add @wapijs/wapi.js
```
</Tab>
<Tab title="yarn">
```bash
yarn add @wapijs/wapi.js
```
</Tab>
<Tab title="npm">
```bash
npm install @wapi/wapi.js
```
</Tab>
</Tabs>

### You may also consider the following best pratices of developing a Node.js Application:

- Setting up a Linter.
- Setting up a formatter.
- Setting up proper scripts in package.json.
- Using a version control system like Git and setting up workflows for Github Actions for sanity build and lint checks.
- Using consistent naming conventions.
- Using environment variables for sensitive information.

<Note> Process to building the application [docs](/guide/building-your-application), for further assistance.</Note>

1 change: 0 additions & 1 deletion apps/js.wapikit.com/guide/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ description: 'Welcome to the home of your new documentation'

## Initiating a Wapi.js project


### Chat bot

The first step to build a wapi.js based chat bot is to create a new node.js project. You can quickly setup a new project using the utility NPM package provided with the wapi.js SDK only, run the following command in your terminal to setup the project:
Expand Down

This file was deleted.

3 changes: 1 addition & 2 deletions apps/js.wapikit.com/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,7 @@
"guide/whatsapp-api-setup/understanding-whatsapp-business-platform",
"guide/whatsapp-api-setup/creating-business-app",
"guide/whatsapp-api-setup/getting-api-key",
"guide/whatsapp-api-setup/configuring-webhook",
"guide/whatsapp-api-setup/account-verification"
"guide/whatsapp-api-setup/configuring-webhook"
]
},
{
Expand Down

0 comments on commit daf9864

Please sign in to comment.