https://github.com/nlamirault/abraracourcix
A simple URL Shortener
https://github.com/nlamirault/abraracourcix
badger boltdb galactus grpc leveldb url-shortener
Last synced: 6 months ago
JSON representation
A simple URL Shortener
- Host: GitHub
- URL: https://github.com/nlamirault/abraracourcix
- Owner: nlamirault
- License: apache-2.0
- Created: 2015-09-05T17:52:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-17T00:32:38.000Z (6 months ago)
- Last Synced: 2024-11-17T01:23:28.048Z (6 months ago)
- Topics: badger, boltdb, galactus, grpc, leveldb, url-shortener
- Language: Go
- Homepage:
- Size: 11.8 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Abraracourcix
[![License Apache 2][badge-license]](LICENSE)
[](https://badge.fury.io/gh/nlamirault%2Fabraracourcix)
Master :
* [](https://circleci.com/gh/nlamirault/abraracourcix/tree/master)
Develop :
* [](https://circleci.com/gh/nlamirault/abraracourcix/tree/develop)
This tool is a simple URL Shortener written in Golang (Require 1.8)
*Abraracourcix* uses [gRPC](http://www.grpc.io) for its message protocol.
The project includes 2 command line utilities:
* *abraracourcixctl*, to communicate with a server *abraracourcixd*
* *abraracourcixadm*, an administration tool to manage the server.
For gRPC-supported languages, *Abraracourcix* provides a JSON gateway, which provides a RESTful proxy that translates HTTP / JSON requests to gRPC messages.
Metrics for [Prometheus](https://prometheus.io/) are exported.
Application traces are available using [OpenTracing](http://opentracing.io/). Supported systems are:
* [x] [Jaeger](https://github.com/uber/jaeger)
* [x] [Zipkin](https://github.com/openzipkin)
Storage backends are :
* [x] [BoltDB](https://github.com/boltdb/bolt)
* [x] [LevelDB](http://leveldb.org/)
* [x] [Redis](https://redis.io/)
* [x] [MongoDB](https://www.mongodb.org/)
* [x] [Badger](https://github.com/dgraph-io/badger)
## Installation
You can download the binaries :
### Abraracourcixd
* Architecture i386 [ [linux](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_linux_386) / [darwin](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_darwin_386) / [freebsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_freebsd_386) / [netbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_netbsd_386) / [openbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_openbsd_386) / [windows](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_windows_386.exe) ]
* Architecture amd64 [ [linux](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_linux_amd64) / [darwin](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_darwin_amd64) / [freebsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_freebsd_amd64) / [netbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_netbsd_amd64) / [openbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_openbsd_amd64) / [windows](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_windows_amd64.exe) ]
* Architecture arm [ [linux](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_linux_arm) / [freebsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_freebsd_arm) / [netbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixd-0.2.0_netbsd_arm) ]
### Abraracourcixctl
* Architecture i386 [ [linux](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_linux_386) / [darwin](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_darwin_386) / [freebsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_freebsd_386) / [netbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_netbsd_386) / [openbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_openbsd_386) / [windows](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_windows_386.exe) ]
* Architecture amd64 [ [linux](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_linux_amd64) / [darwin](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_darwin_amd64) / [freebsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_freebsd_amd64) / [netbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_netbsd_amd64) / [openbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_openbsd_amd64) / [windows](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_windows_amd64.exe) ]
* Architecture arm [ [linux](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_linux_arm) / [freebsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_freebsd_arm) / [netbsd](https://bintray.com/artifact/download/pilotariak/oss/abraracourcixctl-0.2.0_netbsd_arm) ]
### Abraracourcixadm
* Architecture i386 [ [linux](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_linux_386) / [darwin](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_darwin_386) / [freebsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_freebsd_386) / [netbsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_netbsd_386) / [openbsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_openbsd_386) / [windows](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_windows_386.exe) ]
* Architecture amd64 [ [linux](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_linux_amd64) / [darwin](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_darwin_amd64) / [freebsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_freebsd_amd64) / [netbsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_netbsd_amd64) / [openbsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_openbsd_amd64) / [windows](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_windows_amd64.exe) ]
* Architecture arm [ [linux](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_linux_arm) / [freebsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_freebsd_arm) / [netbsd](https://bintray.com/artifact/download/nlamirault/oss/abraracourcixadm-2.0.0_netbsd_arm) ]
## Usage
Launch Zipkin with Docker, and open a browser on 9411:
$ docker run -d -p 9411:9411 openzipkin/zipkin
or Jaeger with Docker (open a browser on 16686):
$ docker run -d -p5775:5775/udp -p16686:16686 jaegertracing/all-in-one:latest
Use the *abraracourcixd* CLI to launch a server:
$ abraracourcixd run --config abraracourcix.toml -v 2 --alsologtostderr
Configure CLI:
$ export ABRARACOURCIX_SERVER="localhost:8080"
$ export ABRARACOURCIX_USERNAME="admin"
$ export ABRARACOURCIX_APIKEY="nimda"
Use the *abraracourcixctl* CLI to use the URLs informations :
$ abraracourcixctl url list
URLs:
$ abraracourcixctl url add --link https://news.google.fr/
URL:
- Key: 5X81VNCDVq
- Link: https://news.google.fr/
- Date: 2017-06-13 17:08:48.898220331 +0200 CEST
$ abraracourcixctl url list
URLs:
- 5X81VNCDVq
$ abraracourcixctl url get --key 5X81VNCDVq
URL:
- Key: 5X81VNCDVq
- Link: https://news.google.fr/
- Date: 2017-06-13 17:08:48.898220331 +0200 CEST
Use the *abraracourcixadm* CLI to manage the server.
$ abraracourcixadm health
+------------+--------+---------+
| SERVICE | STATUS | TEXT |
+------------+--------+---------+
| UrlService | OK | SERVING |
+------------+--------+---------+
$ abraracourcixadm info
+----------------+----------------+---------+--------+
| SERVICE | URI | VERSION | STATUS |
+----------------+----------------+---------+--------+
| abraracourcixd | localhost:8080 | 2.0.0 | OK |
+----------------+----------------+---------+--------+
You could explore the API using [Swagger](http://swagger.io/) UI :
http://localhost:9090/swagger-ui/
## Development
* Initialize environment
$ make init
* Build tool :
$ make build
* Start backends :
$ docker run -d -p 6379:6379 --name redis redis:3
$ docker run -d -p 27017:27017 --name mongo mongo:3.1
* Launch unit tests :
$ make test
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).
## License
See [LICENSE](LICENSE) for the complete license.
## Changelog
A [changelog](ChangeLog.md) is available
## Contact
Nicolas Lamirault
[badge-license]: https://img.shields.io/badge/license-Apache2-green.svg?style=flat