Compare commits
No commits in common. "0bb444cd5061d877f1db625a26f6234f4dee370e" and "a3e5aab6c4b0ee2780d4dc7f153830cdbce63cf9" have entirely different histories.
0bb444cd50
...
a3e5aab6c4
89
README.md
89
README.md
@ -1,91 +1,8 @@
|
||||
# URDT USSD service
|
||||
# ussd
|
||||
|
||||
This is a USSD service built using the [go-vise](https://github.com/nolash/go-vise) engine.
|
||||
> USSD
|
||||
|
||||
## Prerequisites
|
||||
### 1. [go-vise](https://github.com/nolash/go-vise)
|
||||
|
||||
Set up `go-vise` by cloning the repository into a separate directory. The main upstream repository is hosted at: `https://git.defalsify.org/vise.git`
|
||||
```
|
||||
git clone https://git.defalsify.org/vise.git
|
||||
```
|
||||
|
||||
## Setup
|
||||
1. Clone the ussd repo in its own directory
|
||||
|
||||
```
|
||||
git clone https://git.grassecon.net/urdt/ussd.git
|
||||
```
|
||||
|
||||
2. Navigate to the project directory.
|
||||
3. Enter the `services/registration` subfolder:
|
||||
```
|
||||
cd services/registration
|
||||
```
|
||||
4. make the .bin files from the .vis files
|
||||
```
|
||||
make VISE_PATH=/var/path/to/your/go-vise -B
|
||||
```
|
||||
5. Return to the project root (`cd ../..`)
|
||||
6. Run the USSD menu
|
||||
```
|
||||
go run cmd/main.go -session-id=0712345678
|
||||
```
|
||||
## Running the different binaries
|
||||
1. ### CLI:
|
||||
```
|
||||
go run cmd/main.go -session-id=0712345678
|
||||
```
|
||||
2. ### Africastalking:
|
||||
```
|
||||
go run cmd/africastalking/main.go
|
||||
```
|
||||
3. ### Async:
|
||||
```
|
||||
go run cmd/async/main.go
|
||||
```
|
||||
4. ### Http:
|
||||
```
|
||||
go run cmd/http/main.go
|
||||
```
|
||||
|
||||
## Flags
|
||||
Below are the supported flags:
|
||||
|
||||
1. `-session-id`:
|
||||
|
||||
Specifies the session ID. (CLI only).
|
||||
|
||||
Default: `075xx2123`.
|
||||
|
||||
Example:
|
||||
```
|
||||
go run cmd/main.go -session-id=0712345678
|
||||
```
|
||||
|
||||
2. `-d`:
|
||||
|
||||
Enables engine debug output.
|
||||
|
||||
Default: `false`.
|
||||
|
||||
Example:
|
||||
```
|
||||
go run cmd/main.go -session-id=0712345678 -d
|
||||
```
|
||||
|
||||
3. `-db`:
|
||||
|
||||
Specifies the database type.
|
||||
|
||||
Default: `gdbm`.
|
||||
|
||||
Example:
|
||||
```
|
||||
go run cmd/main.go -session-id=0712345678 -d -db=postgres
|
||||
```
|
||||
|
||||
>Note: If using `-db=postgres`, ensure PostgreSQL is running with the connection details specified in your `.env` file.
|
||||
USSD service.
|
||||
|
||||
## License
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user