Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thuongtruong1009/short1url
🔗 Ship your link in an easier way
https://github.com/thuongtruong1009/short1url
cicd container docker docker-compose dockerfile github go golang nginx nuxt nuxt3 nuxtjs redis rest-api reverse-proxy seo shortener
Last synced: about 1 month ago
JSON representation
🔗 Ship your link in an easier way
- Host: GitHub
- URL: https://github.com/thuongtruong1009/short1url
- Owner: thuongtruong1009
- License: mit
- Created: 2023-06-09T16:59:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-05T17:06:38.000Z (about 1 year ago)
- Last Synced: 2024-05-17T00:26:10.894Z (7 months ago)
- Topics: cicd, container, docker, docker-compose, dockerfile, github, go, golang, nginx, nuxt, nuxt3, nuxtjs, redis, rest-api, reverse-proxy, seo, shortener
- Language: Vue
- Homepage: https://short1url.thuongtruong.me
- Size: 2.18 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
SHORT1URL
## Description
This is a simple URL shortener service. It is written in Golang and uses Redis as database. Other hand, it also provides some services such as QR code generator, barcode generator, etc.
## Preview
## What's new
- [x] Shorten URL
- [x] Redirect to original URL
- [x] Expiration time
- [x] Statistics
- [x] Rate limit
- [x] QR code generator (custom color, download image)
- [x] Barcode generator
- [x] Microservices Dockerize
- [x] Auto build and deploy image
- [x] Reverse proxy
- [ ] Unit test
- [ ] Caching
## Architecture
## Getting started
1. Clone this repo
```bash
git clone https://github.com/thuongtruong1009/short1url.git
```
2. Fill in environment variables
```bash
# client
cd api && cp .env.example .env
# server
cd client && cp .env.example .env
```
3. Run Docker container
```bash
docker-compose up -d
```
4. Testing API
```bash
# with browser
Open http://localhost:81/s
```
```bash
# with Postman or browser
POST http://localhost:81/s
body: {
"url": ""
}
```
```bash
# with curl
curl -X POST 'http://localhost:81/s'
-H 'Content-Type: application/json'
-d '{"url": ""}"
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If you like my work, please star 🌟 this repository.
## License
**Short1url** is an [MIT-licensed](LICENSE) open source project.
Copyright of thuongtruong1009