https://github.com/zenorachi/url-shortener
Simple url shortener service.
https://github.com/zenorachi/url-shortener
docker docker-compose go golang golangci-lint grpc grpc-gateway makefile redis swagger
Last synced: 3 months ago
JSON representation
Simple url shortener service.
- Host: GitHub
- URL: https://github.com/zenorachi/url-shortener
- Owner: zenorachi
- License: mit
- Created: 2023-08-10T16:36:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T16:37:27.000Z (almost 2 years ago)
- Last Synced: 2025-04-11T03:45:43.733Z (3 months ago)
- Topics: docker, docker-compose, go, golang, golangci-lint, grpc, grpc-gateway, makefile, redis, swagger
- Language: Go
- Homepage:
- Size: 197 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Url Shortener
Simple url shortener service written in Golang.
#### Technologies used:
* [Golang](https://go.dev)
* [gRPC Gateway](https://grpc-ecosystem.github.io/grpc-gateway/)
* [Redis](https://redis.io/)
* [Swagger](https://swagger.io)
---
## Getting started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these example steps.
### Installation
1. Clone the repository:
```shell
git clone https://github.com/zenorachi/url-shortener
```
2. Setup environment variables (create .env file in the project's root):
```dotenv
export REDIS_HOST=
export REDIS_PORT=
export REDIS_PASSWORD=
export REDIS_INDEX=
```
> **Note:** if you build the project using Docker, setup *DB_HOST=redis* (as the container name)
3. Compile and run the project:
```shell
make
```