Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nightwolf93/brisk
Brisk is a simple url shortener API
https://github.com/nightwolf93/brisk
api circleci geoip go url-shortener
Last synced: about 2 months ago
JSON representation
Brisk is a simple url shortener API
- Host: GitHub
- URL: https://github.com/nightwolf93/brisk
- Owner: nightwolf93
- Created: 2020-07-28T16:22:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T18:33:20.000Z (over 4 years ago)
- Last Synced: 2024-06-20T13:41:00.284Z (7 months ago)
- Topics: api, circleci, geoip, go, url-shortener
- Language: Go
- Homepage:
- Size: 171 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Brisk
[](https://github.com/nightwolf93/brisk)
Brisk is a simple url shortener API.
It will allow you to create short url for temporary url like for a 2FA system.
It also provide geoip detection for analytics
## Documentation
https://nico-style931.gitbook.io/brisk/
## 3rd Party packages
| Package | URL |
| ---------------- | ------------------------------------------ |
| BriskDotNet (C#) | https://github.com/nightwolf93/BriskDotNet |
| php-brisk (PHP) | https://github.com/nightwolf93/php-brisk |
## Docker
Brisk have a docker image here : https://hub.docker.com/r/nightwolf931/brisk
#### Environment variables
| Name | Description |
| -------------------- | --------------------------- |
| MASTER_CLIENT_ID | ClientID of the master |
| MASTER_CLIENT_SECRET | Client secret of the master |
| MAX_LINK_TTL | Max TTL for a link |
| BASE_URL | The base URL for links |
#### Exposed port
The exposed http port by Brisk is the port **3000**
## Build
```
make build
```
```
make docker
```
## Test
```
make test
```
## Authors
Nightwolf93