https://github.com/mamal72/dgkala-api
A simple iris based API for DGKala
https://github.com/mamal72/dgkala-api
api dgkala http iris json-api
Last synced: about 1 month ago
JSON representation
A simple iris based API for DGKala
- Host: GitHub
- URL: https://github.com/mamal72/dgkala-api
- Owner: mamal72
- License: mit
- Created: 2017-02-03T13:10:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-03T13:19:02.000Z (about 8 years ago)
- Last Synced: 2024-06-20T12:01:50.765Z (11 months ago)
- Topics: api, dgkala, http, iris, json-api
- Language: Go
- Homepage:
- Size: 1.06 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dgkala-api
A dead simple HTTP API for [dgkala](https://github.com/mamal72/dgkala).
## Installation
```bash
go get github.com/mamal72/dgkala-api
```
## Usage
```bash
dgkala-api
```
*You can also set ENV variables or run the app like this to change host or port:*
```bash
HOST="localhost" PORT="5000" dgkala-api
```
Now you can send simple `GET` http requests to following addresses:
- `http://HOST:PORT/search/:keyword`
- `http://HOST:PORT/incredible-offers`.
## Development
1. Clone the repository.
1. Edit the example config ENV config in `.env.example` file and add `PORT` and `HOST`.
1. Rename `.env.example` to `.env`.
1. Build or run the app.
## Ideas || Issues
Just create an issue and describe it. I'll check it ASAP!
## Contribution
You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. :heart:
## License
Licensed under the [MIT License](https://github.com/mamal72/dgkala-api/blob/master/LICENSE).