https://github.com/thenriquedb/url-shortener
A simple URL shortener built with Spring Boot and MongoDB as a proof of concept for learning purposes.
https://github.com/thenriquedb/url-shortener
docker docker-compose java mongodb redis redis-cache spring-boot terraform url-shortener
Last synced: 2 months ago
JSON representation
A simple URL shortener built with Spring Boot and MongoDB as a proof of concept for learning purposes.
- Host: GitHub
- URL: https://github.com/thenriquedb/url-shortener
- Owner: thenriquedb
- Created: 2025-05-16T14:41:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-24T23:52:32.000Z (12 months ago)
- Last Synced: 2025-07-25T04:41:16.760Z (12 months ago)
- Topics: docker, docker-compose, java, mongodb, redis, redis-cache, spring-boot, terraform, url-shortener
- Language: Java
- Homepage:
- Size: 56.6 KB
- Stars: 22
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# URL Shortener (Spring Boot + MongoDB)
A simple proof-of-concept (POC) URL shortener built with Spring Boot and MongoDB for learning purposes.
## Stack
- Java 21;
- Spring Boot;
- MongoDB;
- Docker compose;
## Endpoints
### Shorten URL
- **URL**: `/shorten`
- **Method**: `POST`
- **Request Body**:
```json
{
"url": "https://example.com",
"expiresAt": "2025-05-21T11:28:00" // Optional
}
```
- **Response**:
```json
{
"shortUrl": "http://localhost:8080/abc123",
"expiresAt": "2025-05-21T11:28:00" // Or null if not set
}
```
### Redirect Shortened URL
- **URL**: `/{id}`
- **Method**: `GET`
- **Response**: Redirects to the original URL.
## Running with Docker Compose
```bash
docker compose --profile production up --build -d
```
## Runing with Docker Swarm
**1. Create Docker secrets**
```bash
echo 8081 | docker secret create APP_PORT -
echo mongo | docker secret create MONGO_HOST -
echo 27017 | docker secret create MONGO_PORT -
echo root | docker secret create MONGO_USER -
echo password | docker secret create MONGO_PASSWORD -
echo url_shortener | docker secret create MONG0_DB -
echo cache | docker secret create REDIS_HOST -
echo 6379 | docker secret create REDIS_PORT -
```
**2. Run with Docker Swarm**
```bash
docker swarm init
```
**3. Deploy the stack**
```bash
docker stack deploy -c docker-swarm.yml url_shortener
```