Skip to content

feat: documentation moved to mintlify with api extractor and typedoc markdown generator for typescript code files #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 38 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
9fd8c67
feat: adding guide with contentlayer, wip
sarthakjdev May 16, 2024
00eb02f
Merge branch 'master' of github.com:sarthakjdev/wapi.js into feat/gui…
sarthakjdev May 29, 2024
13b0ae8
test
sarthakjdev Jun 1, 2024
68488ee
feat: docs gen using mintlify typedoc and api extractor
sarthakjdev Jun 1, 2024
5595073
feat: docs gen using mintlify typedoc and api extractor
sarthakjdev Jun 1, 2024
161a86b
fix: docs
sarthakjdev Jun 1, 2024
c1382c6
fix: docs
sarthakjdev Jun 1, 2024
a0e686d
fix: docs
sarthakjdev Jun 1, 2024
d489cab
feat: add more docs pages
sarthakjdev Jun 1, 2024
5541af9
docs: add docs update
sarthakjdev Jun 2, 2024
7ce90bf
docs: add docs update
sarthakjdev Jun 2, 2024
3f67988
docs: add docs updates
sarthakjdev Jun 2, 2024
8b8be26
chore: remove documentation workflows as docs has been moved to mintlifu
sarthakjdev Jun 3, 2024
13bbbe0
chore: assets updated
sarthakjdev Jun 3, 2024
234c784
chore: docs updated
sarthakjdev Jun 3, 2024
22b3dae
fix: library to SDK
sarthakjdev Jun 3, 2024
58c1c22
fix: docs update
sarthakjdev Jun 4, 2024
8aa3fdf
feat: add meta business account creation workflow
sarthakjdev Jun 5, 2024
0db3c8b
feat: add webhook configuration process steps
sarthakjdev Jun 5, 2024
925bf90
fix: typos
sarthakjdev Jun 5, 2024
122ade9
fix: bifurcate product and product list message into more smaller com…
sarthakjdev Jun 5, 2024
97ebf17
fix: bifurcate product and product list message into more smaller com…
sarthakjdev Jun 5, 2024
f3c1c98
fix: linter
sarthakjdev Jun 5, 2024
1b066ed
fix: linter
sarthakjdev Jun 5, 2024
cdd7cae
docs: update doc
sarthakjdev Jun 5, 2024
d7b9012
docs: update doc
sarthakjdev Jun 5, 2024
daf9864
docs: update doc
sarthakjdev Jun 5, 2024
e18c926
docs: update doc
sarthakjdev Jun 6, 2024
fffe314
chore: dire name update
sarthakjdev Jun 6, 2024
c7a6e94
chore: screenshots replaced
sarthakjdev Jun 6, 2024
dcbdd6d
chore: screenshots replaced
sarthakjdev Jun 6, 2024
e52e333
fix: mint json
sarthakjdev Jun 6, 2024
fbf372a
fix: featue description
sarthakjdev Jun 6, 2024
cc91075
fix: bold
sarthakjdev Jun 6, 2024
9c0b5e4
fix: bold
sarthakjdev Jun 6, 2024
925257a
fix: bold
sarthakjdev Jun 6, 2024
810abf2
fix: add slack link
sarthakjdev Jun 6, 2024
52573c8
fix: remove ds store file
sarthakjdev Jun 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 0 additions & 91 deletions .github/workflows/documentation-preview.yaml

This file was deleted.

141 changes: 0 additions & 141 deletions .github/workflows/documentation-prod.yaml

This file was deleted.

16 changes: 0 additions & 16 deletions .github/workflows/format-tag/action.yml

This file was deleted.

22 changes: 0 additions & 22 deletions .github/workflows/format-tag/formatTag.js

This file was deleted.

11 changes: 0 additions & 11 deletions .github/workflows/format-tag/index.js

This file was deleted.

20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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://wapijs.co"><img src="https://media.discordapp.net/attachments/1046394448088674371/1247281980111061054/wapijs_banner.png?ex=665f755d&is=665e23dd&hm=b0f47091e442022d562ee535c8fefdf1d9006db11e09ea5d380186ab4a40a97a&=&format=webp&quality=lossless&width=2261&height=1034" alt="@wapijs/wapi.js" /></a>
</p>
<br />
<p>
Expand All @@ -13,7 +13,7 @@

## 📌 Status

Beta Version - This library is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues).
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).

## 📖 About

Expand All @@ -35,15 +35,15 @@ Wapi.js is a JavaScript module, written in TypeScript, designed to interact with

## 💻 Installation

Ensure you have the Node.js 18 LTS version to use this library.
Ensure you have the Node.js 18 LTS version to use this SDK.

```sh
npm install @wapijs/wapi.js
yarn add @wapijs/wapi.js
pnpm install @wapijs/wapi.js
```

> Note: This library is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source library built for developers to support them in building whatsapp cloud api based chat bots easily.
> Note: This SDK is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source SDK built for developers to support them in building whatsapp cloud api based chat bots easily.

## 🚀 Usage

Expand Down Expand Up @@ -81,7 +81,7 @@ import { Client, TextMessage } from 'wapi.js'
})

await whatsappClient.message.send({
message: new TextMessage({ text: 'hiii, this is wapijs library' }),
message: new TextMessage({ text: 'hiii, this is wapijs SDK' }),
phoneNumber: 'XXXXXXXXXX'
})

Expand All @@ -91,13 +91,19 @@ import { Client, TextMessage } from 'wapi.js'

whatsappClient.on('TextMessage', async (message) => {
message.reply({
message: new TextMessage({ text: 'hiii, this is wapijs library' }),,
message: new TextMessage({ text: 'hiii, this is wapijs SDK' }),,
})
})

whatsappClient.initiate()
```

## Upcoming features:

- [Interactive Address Message Support](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/address-messages)
- [Business Management API Support](https://developers.facebook.com/docs/whatsapp/business-management-api)
-

## 🤝 Contribution Guidelines

1. Fork the Project
Expand All @@ -118,4 +124,4 @@ Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE).
- Email: sarthak@softlancer.co
- [Twitter](https://twitter.com/sarthakjdev) | [LinkedIn](https://www.linkedin.com/in/sarthakjdev)

Note: This library is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization.
Note: This SDK is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization.
Binary file removed apps/.DS_Store
Binary file not shown.
Loading
Loading