Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimaskiddo/go-whatsapp-rest
Go WhatsApp Implementation in REST API
https://github.com/dimaskiddo/go-whatsapp-rest
api go golang rest server whatsapp whatsapp-api whatsapp-web
Last synced: 1 day ago
JSON representation
Go WhatsApp Implementation in REST API
- Host: GitHub
- URL: https://github.com/dimaskiddo/go-whatsapp-rest
- Owner: dimaskiddo
- Archived: true
- Created: 2019-03-03T00:06:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T05:17:16.000Z (about 1 year ago)
- Last Synced: 2024-09-19T20:01:56.758Z (7 days ago)
- Topics: api, go, golang, rest, server, whatsapp, whatsapp-api, whatsapp-web
- Language: Go
- Homepage:
- Size: 122 KB
- Stars: 130
- Watchers: 15
- Forks: 44
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go WhatsApp Implementation in REST API
This repository contains example of implementation [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) package. This example is using a codebase from [dimaskiddo/codebase-go-rest-lite](https://github.com/dimaskiddo/codebase-go-rest-lite).
### Warning
Since WhatsApp is migrating to Multi-Device support then this repository might be unusable in the future. For Go WhatsApp REST with Multi-Device support please visit the new repository [dimaskiddo/go-whatsapp-multidevice-rest](https://github.com/dimaskiddo/go-whatsapp-multidevice-rest)
## 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)
* Dep (Go Dependencies Management Tool)
* 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
export GOPATH=$GOPATH:"`pwd`"
```
* Under the Go Workspace directory create a source directory
```
mkdir -p src/github.com/dimaskiddo/go-whatsapp-rest
```
* Move to the created directory and pull codebase
```
cd src/github.com/dimaskiddo/go-whatsapp-rest
git clone -b master https://github.com/dimaskiddo/go-whatsapp-rest.git .
```
* Run following command to pull dependecies package
```
make vendor
```
* Until this step you already can run this code by using this command
```
make run
```
## Running The Tests
Currently the test is not ready yet :)
## 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
Or use Docker Images available in dimaskiddo/go-whatsapp-rest
## API Access
You can access any endpoint under **ROUTER_BASE_PATH** configuration by default located at */api/v1/whatsapp*.
Configuration files are located in *share/etc* directory.
## Built With
* [Go](https://golang.org/) - Go Programming Languange
* [Dep](https://github.com/golang/dep) - Go Dependency Management Tool
* [GoReleaser](https://github.com/goreleaser/goreleaser) - Go Automated Binaries Build
* [Make](https://www.gnu.org/software/make/) - GNU Make Automated Execution
* [Docker](https://www.docker.com/) - Application Containerization
## Authors
* **Dimas Restu Hidayanto** - *Initial Work* - [DimasKiddo](https://github.com/dimaskiddo)
See also the list of [contributors](https://github.com/dimaskiddo/go-whatsapp-rest/contributors) who participated in this project
## Annotation
You can seek more information for the make command parameters in the [Makefile](https://raw.githubusercontent.com/dimaskiddo/go-whatsapp-rest/master/Makefile)