Home

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Prequisites package:

• Go (Go Programming Language)
• Make (Automated Execution using Makefile)

Optional package:

• GoReleaser (Go Automated Binaries Build)
• Docker (Application Containerization)

Installing

Below is the instructions to make this codebase running:

• Create a Go Workspace directory and export it as the extended GOPATH directory

cd <your_go_workspace_directory>
export GOPATH=$GOPATH:"`pwd`"

• Under the Go Workspace directory create a source directory

mkdir -p src/github.com/dimaskiddo/go-whatsapp-multidevice-rest

• Move to the created directory and pull codebase

cd src/github.com/dimaskiddo/go-whatsapp-multidevice-rest
git clone -b master https://github.com/dimaskiddo/go-whatsapp-multidevice-rest.git .

• Run following command to pull dependecies package

make vendor

• Until this step you already can run this code by using this command

ln -sf .env.development .env
make run

Updating

git pull
make clean
make vendor
make run

Deployment

To build this code to binaries for distribution purposes you can run following command:

make release

The build result will shown in build directory

API Access

You can access any endpoint under BASE_URL environment variable which by default located at .env file.

Integrated API Documentation can be accessed in BASE_URL/docs/index.html or by default it's in 127.0.0.1:3000/api/v1/whatsapp/docs/index.html

NEXT

• Configuration explanation
• End point and API Explanation

---

Built With

• Go - Go Programming Languange
• GoReleaser - Go Automated Binaries Build
• Make - GNU Make Automated Execution
• Docker - Application Containerization