feat: update readme.md

Author: mamadcloud

README.MD

@@ -1,14 +1,21 @@
-# Payment library #
+# Chip NodeJS library
 
-## Installing ##
+## Prerequisite
+Before you start, make sure you already have created `Brand ID` and `API Key` from your developer dashboard by logging-in into [merchant portal](https://gate.chip-in.asia/login).
 
-## npm ##
+## Installation
 
+### npm
 ```bash
 npm install git+ssh://git@github.com/CHIPAsia/chip-nodejs-sdk.git#v1.0.0
 ```
 
-## Getting Started ##
+### yarn
+```bash
+yarn add git+ssh://git@github.com/CHIPAsia/chip-nodejs-sdk.git#v1.0.0
+```
+
+## Getting Started
 
 Simple usage looks like:
 
@@ -34,12 +41,11 @@ let callback = (error, data, response) => {
 apiInstance.paymentMethods(brandId, "EUR", {}, callback);
 ```
 
-## Examples ##
-
-See `example.js` for more examples
-
-## Testing ##
+## Testing
 
 ```bash
 npm run test
-```
+```
+
+## Example
+Check our examples [here](./examples).

examples/.gitignore

@@ -0,0 +1,8 @@
+# misc
+.DS_STORE
+
+# nodes
+node_modules/
+package-lock.json
+yarn.lock
+yarn-error.log

examples/README.md

@@ -0,0 +1,78 @@
+<div align="center">
+    <a href="https://nodejs.org">
+        <img
+            alt="NodeJS"
+            src="https://nodejs.org/static/images/logo.svg"
+            width="150"
+            style="background-color:black;padding:15px;border-radius:5px">
+    </a>
+</div>
+
+---
+
+## Requirements
+* It is required `Node` version >= 14
+* `yarn` or `npm` to run scripts/install dependencies
+
+## Prerequisite
+You will need to replace the value on file [config.js](./config.js) with the configuration on your Developer section by logging-in to Merchant Portal with your account.
+
+```javascript
+// config.js
+const config = {
+  brandId: '<<BRAND_ID>>',
+  apiKey: '<<API_KEY>>',
+  endpoint: 'https://gate.chip-in.asia/api/v1',
+  basedUrl: '<<DOMAIN_URL>>',
+  webhookPublicKey: '<<WEBHOOK_PUBLIC_KEY>>'
+}
+
+module.exports = config
+```
+
+**BRAND_ID**
+
+Obtain your BRAND_ID from Developer section.
+
+---
+**API_KEY**
+
+Obtain your API_KEY from Developer section.
+
+---
+
+**WEBHOOK_PUBLIC_KEY**
+
+Obtain your `WEBHOOK_PUBLIC_KEY` from Developer section. You can register the URL from [API](https://developer.chip-in.asia/api) or from Merchant Portal on Developer section.
+
+---
+
+**DOMAIN_URL**
+
+It is your domain URL
+
+## Run Example
+1. Install dependencies:
+```bash
+npm i 
+
+# OR
+
+yarn
+```
+
+2. Run application locally:
+```bash
+node run start
+
+# OR
+
+yarn start
+```
+
+and visit [localhost:7001](http://localhost:7001) on your browser.
+To test `/api/callback` & `/api/webhook` to be called from our server, make sure it is connected to internet (exposed to outside). 
+
+We recommend to use [ngrok](https://ngrok.com/) if you want to run locally for debugging. Then You can replace `DOMAIN_URL` with generated URL by `ngrok`. 
+
+`NB: Use it at your own risk. Make sure do not expose your critical port.`

examples/app.js

@@ -49,7 +49,7 @@ app.get('/', async (req, res) => {
   })
 })
 
-app.get('/payment_methods', async (req, res) => {
+app.get('/api/payment_methods', async (req, res) => {
   apiInstance.paymentMethods(brandId, "MYR", {}, function(error, data, response) {
     if (error) {
       console.log('API call failed. Error:', error)
@@ -61,7 +61,7 @@ app.get('/payment_methods', async (req, res) => {
   })
 })
 
-app.get('/create_purchase', async (req, res) => {
+app.get('/api/create_purchase', async (req, res) => {
   const client = { email: 'test@test.com' }
   const product = { name: 'Test', price: 100 }
   const details = { products: [ product ] }
@@ -71,7 +71,7 @@ app.get('/create_purchase', async (req, res) => {
     purchase: details,
     success_redirect: `${basedUrl}/redirect.php?success=1`,
     failure_redirect: `${basedUrl}/redirect.php?success=0`,
-    success_callback: `${basedUrl}/callback`
+    success_callback: `${basedUrl}/api/callback`
   }
 
   apiInstance.purchasesCreate(purchase, function(error, data, response) {
@@ -86,7 +86,7 @@ app.get('/create_purchase', async (req, res) => {
   })
 })
 
-app.post('/callback', async (req, res) => {
+app.post('/api/callback', async (req, res) => {
   const { rawBody, headers } = req
   const xsignature = headers['x-signature']
   const publicKey = JSON.parse(await getPublicKey())
@@ -96,7 +96,7 @@ app.post('/callback', async (req, res) => {
   res.end()
 })
 
-app.post('/webhook/payment', async (req, res) => {
+app.post('/api/webhook/payment', async (req, res) => {
   const { rawBody, headers } = req
   const parsed = JSON.parse(rawBody)
   const xsignature = headers['x-signature']
@@ -108,9 +108,9 @@ app.post('/webhook/payment', async (req, res) => {
   res.end("WEBHOOK OK!")
 })
 
-app.get('/public_key', async (req, res) => {
+app.get('/api/public_key', async (req, res) => {
   const data = await getPublicKey()
-  res.end(data)
+  res.setHeader('Content-Type', 'application/json').end(JSON.parse(data))
 })
 
 const getPublicKey = () => {

examples/config.js

@@ -2,7 +2,7 @@ const config = {
   brandId: '<<BRAND_ID>>',
   apiKey: '<<API_KEY>>',
   endpoint: 'https://gate.chip-in.asia/api/v1',
-  basedUrl: '<<YOU_DOMAIN_URL>>',
+  basedUrl: '<<DOMAIN_URL>>',
   webhookPublicKey: '<<WEBHOOK_PUBLIC_KEY>>'
 }
 

examples/index.html

@@ -5,13 +5,13 @@ <h1>Demo Merchant</h1>
     <span>Sample Actions:</span>
     <ul>
       <li>
-        <a href="/payment_methods" target="_blank">Get Payment Methods</a>
+        <a href="/api/payment_methods" target="_blank">Get Payment Methods</a>
       </li>
       <li>
-        <a href="/create_purchase" target="_blank">Create Checkout</a>
+        <a href="/api/create_purchase" target="_blank">Create Checkout</a>
       </li>
       <li>
-        <a href="/public_key" target="_blank">Get Public Key</a>
+        <a href="/api/public_key" target="_blank">Get Public Key</a>
       </li>
     </ul>
   </body>

examples/package.json

@@ -11,8 +11,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "Chip": "git+ssh://git@github.com/CHIPAsia/chip-nodejs-sdk.git#v1.0.0",
     "body-parser": "^1.20.1",
-    "Chip": "github:CHIPAsia/chip-nodejs-sdk",
     "express": "^4.18.2"
   },
   "devDependencies": {