chore: removed UI package, add docs for cloudflare tunnel usage for l…

…ocal development and other minor doc fixes (#36)

CONTRIBUTING.md

@@ -37,7 +37,7 @@ to .
 
 ## I Have a Question
 
-> If you want to ask a question, we assume that you have read the available [Documentation](https://wapijs.co).
+> If you want to ask a question, we assume that you have read the available [Documentation](https://javascript.wapikit.com).
 
 Before you ask a question, it is best to search for existing [Issues](https://github.com/sarthakjdev/wapi.js/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
 
@@ -79,7 +79,7 @@ Depending on how large the project is, you may want to outsource the questioning
 A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
 
 - Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://wapijs.co). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://javascript.wapikit.com). If you are looking for support, you might want to check [this section](#i-have-a-question)).
 - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/sarthakjdev/wapi.js/issues?q=label%3Abug).
 - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
 - Collect information about the bug:
@@ -121,7 +121,7 @@ This section guides you through submitting an enhancement suggestion for Wapi.js
 #### Before Submitting an Enhancement
 
 - Make sure that you are using the latest version.
-- Read the [documentation](https://wapijs.co) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Read the [documentation](https://javascript.wapikit.com) carefully and find out if the functionality is already covered, maybe by an individual configuration.
 - Perform a [search](https://github.com/sarthakjdev/wapi.js/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
 

README.md

@@ -1,16 +1,18 @@
 <div align="center">
 <br />
 <p align="center">
-<a href="https://wapijs.co"><img src="https://media.discordapp.net/attachments/1046394448088674371/1247281980111061054/wapijs_banner.png?ex=6662c11d&is=66616f9d&hm=d930fdb0c01a9651a9197c9226209ac1ab2dfdf099b4faf198613b13aaf88721&=&format=webp&quality=lossless&width=2261&height=1034" alt="@wapijs/wapi.js" /></a>
+<a href="https://javascript.wapikit.com"><img src="https://mintlify.s3-us-west-1.amazonaws.com/na-730c8179/assets/banner.svg" alt="@wapijs/wapi.js" /></a>
 </p>
 <br />
 <p>
   <a href="/"><img src="https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white" /></a>
-  <a href="https://www.npmjs.com/package/@whatsappjs/Wapi.js"><img src="https://img.shields.io/badge/NPM-%23000000.svg?style=for-the-badge&logo=npm&logoColor=white" /></a>
+  <a href="https://www.npmjs.com/package/@wapijs/wapi.js"><img src="https://img.shields.io/badge/NPM-%23000000.svg?style=for-the-badge&logo=npm&logoColor=white" /></a>
   <a href=""><img src="https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white" /></a>
 </p>
 </div>
 
+Visit the documentation of the SDK [here](https://javascript.wapikit.com)
+
 ## 📌 Status
 
 Beta Version - This SDK is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues).
@@ -61,11 +63,6 @@ pnpm create-wapi-app
 
 - **Notification Payloads**: Details can be found [here](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components).
 
-## 🔗 Other Links
-
-- [Website](https://wapijs.co)
-- [Documentation](https://wapijs.co/docs)
-
 ## Example Usage
 
 ```typescript
@@ -116,7 +113,7 @@ For detailed guidelines, check [Contributing.md](./CONTRIBUTING.md).
 
 ## 📜 License
 
-Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE).
+Distributed under the AGPL 3.0 License. View [LICENSE](./LICENSE).
 
 ## 📞 Contact
 

apps/docs/guide/whatsapp-api-setup/configuring-webhook.mdx

@@ -10,8 +10,15 @@ To receive messages from your customers, you need to configure a webhook for you
 ## Configuring Webhook for local development setup
 
 
+### Getting a public URL for your local development setup
 
-### NGROK
+<Note>You may sometimes face an error on the whatsapp webhook management dashboard saying that the URL is malicious in case when you are using NGROK, in that case you must go ahead with using cloudflare tunnel.</Note>
+
+- [Using NGROK](#ngrok)
+- [Using Cloudflare Tunnel](#cloudflare-tunnel)
+
+
+#### NGROK
 
 If you are developing your application locally, you can use [ngrok](https://ngrok.com/) to expose your local server to the internet.
 
@@ -28,6 +35,26 @@ ngrok http http://localhost:<your-application-port>
     <img src="/assets/configure-webhook/1.png" />
   </Frame>
 
+<Note>Make sure to replace `<your-application-port>` with the port number on which your application is running.</Note>
+
+
+####  Cloudflare Tunnel
+
+To use cloudflare tunnel, follow these steps:
+
+1. Download and install cloudflare tunnel from [here](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation).
+2. Run the following command in your terminal to expose your local server to the internet:
+
+```bash
+cloudflared tunnel --url http://localhost:<your-application-port>
+```
+
+3. You will see something like this in your terminal:
+  <Frame>
+    <img src="/assets/configure-webhook/cloudlfare.png" />
+  </Frame>
+
+<Note>Make sure to replace `<your-application-port>` with the port number on which your application is running.</Note>
 
 
 ### Submitting URL to whatsapp business platform
@@ -49,8 +76,8 @@ Follow the steps below to submit your webhook URL to the Whatsapp Business Platf
         </Accordion>
     </Step>
     <Step>
-        <Accordion title="Add the NGROK public URL and webhook secret.">
-            <Note>Webhook secret is the same string which you have used in your Wapi.js Application Client.</Note>
+        <Accordion title="Add the public URL and webhook secret.">
+            <Note>Webhook secret is the same string which you have used in your Wapi.go Application Client.</Note>
 
             <Frame>
                 <img src="/assets/configure-webhook/3.png" />

package.json

@@ -31,7 +31,7 @@
   "authors": [
     "sarthak@softlancer.co"
   ],
-  "license": "Apache-2.0",
+  "license": "AGPL-3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sarthakjdev/wapi.js.git"

packages/create-wapi-app/README.md

@@ -1,7 +1,7 @@
 <div align="center">
 <br />
 <p align="center">
-<a href="https://wapijs.co"><img src="https://www.wapijs.co/assets/logo/logo-light.svg" alt="@wapijs/wapi.js"  height="200" width="360" /></a>
+<a href="https://javascript.wapikit.com"><img src="https://www.javascript.wapikit.com/assets/logo/logo-light.svg" alt="@wapijs/wapi.js"  height="200" width="360" /></a>
 </p>
 <br />
 <p>

packages/create-wapi-app/package.json

@@ -37,8 +37,8 @@
     "chat-bot",
     "whatsapp-bot"
   ],
-  "homepage": "https://www.wapijs.co",
-  "license": "Apache-2.0",
+  "homepage": "https://javascript.wapikit.com",
+  "license": "AGPL-3.0",
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^12.0.0",

packages/create-wapi-app/src/create-bot.ts

@@ -74,8 +74,7 @@ export async function createWhatsappBot(options: {
   if (bun) {
     await cp(
       new URL(
-        `../template/Bun/${
-          isTypescriptEnabled ? "typescript" : "javascript"
+        `../template/Bun/${isTypescriptEnabled ? "typescript" : "javascript"
         }/package.json`,
         import.meta.url,
       ),
@@ -139,7 +138,7 @@ export async function createWhatsappBot(options: {
   console.log();
   console.log(
     chalk.green(
-      `Setup done!! You can visit the documentation here https://wapijs.co, to smoothly build your bot.`,
+      `Setup done!! You can visit the documentation here https://javascript.wapikit.com, to smoothly build your bot.`,
     ),
   );
 }

packages/example-chat-bot/src/index.ts

@@ -24,7 +24,7 @@ function init() {
 		'Getting Started': [
 			{
 				question: 'How do I get started with wapi.js?',
-				answer: 'Check out the docs at https://wapijs.co/docs and use the "create-wapi-app" template.'
+				answer: 'Check out the docs at https://javascript.wapikit.com/ and use the "create-wapi-app" template.'
 			},
 			{
 				question: 'Is wapi.js easy to learn?',
@@ -48,7 +48,7 @@ function init() {
 		'Help & Support': [
 			{
 				question: 'Is wapi.js free and open-source?',
-				answer: "Yes, it's completely free and open-source under the Apache 2.0 License."
+				answer: "Yes, it's completely free and open-source under the AGPL 3.0 License."
 			},
 			{
 				question: 'Where can I get help or support for wapi.js?',