URL Shortener API – Implementation

.gitignore

@@ -0,0 +1,3 @@
+# Exclude the actual build output
+target/
+.idea/

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,3 @@
+wrapperVersion=3.3.4
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip

Dockerfile

@@ -0,0 +1,18 @@
+# Stage 1: Build the application
+FROM maven:3.9.6-eclipse-temurin-17 AS build
+COPY . /app
+WORKDIR /app
+RUN mvn clean package -DskipTests
+
+# Stage 2: Run the application
+FROM eclipse-temurin:17-jre-jammy
+WORKDIR /app
+
+# Copy only the built jar from the build stage
+COPY --from=build /app/target/url_shortener-1.0.0.jar app.jar
+
+# expose port
+EXPOSE 8080
+
+# run app
+ENTRYPOINT ["java", "-jar", "app.jar"]

README.md

@@ -42,3 +42,317 @@ It should:
   - How to build and run locally.
   - Example usage (frontend and API).
   - Any notes or assumptions.
+-----------------------------------------------------------
+-------------------------------------------------------------
+# URL Shortener API (Spring Boot)
+
+A RESTful API for shortening URLs, retrieving them, redirecting, and deleting entries.
+
+---
+
+## 🚀 Features
+
+* Create short URLs (with optional custom alias)
+* Redirect to original URL
+* List all shortened URLs
+* Delete URLs
+* H2 (dev/test)
+* Integration & unit tests
+* Docker support
+
+---
+
+## 🛠️ Tech Stack
+
+* Java 17
+* Spring Boot 3.5
+* Spring Web (REST APIs)
+* Spring Data JPA
+* H2 Filebased mode
+* Maven
+* JaCoCo (code coverage)
+
+---
+
+## 📦 Prerequisites
+
+* Java 17+
+* Maven (or use Maven Wrapper `./mvnw`)
+* Node.js (if running frontend)
+* Docker (optional)
+
+---
+
+## ⚙️ Getting Started
+
+### 1. Clone the repository
+
+```bash
+git clone <your-repo-url>
+cd url-shortener
+```
+
+---
+
+### 2. Build the project
+
+```bash
+./mvnw clean install
+```
+
+---
+
+### 3. Run the application
+Set SpringBoot Profile as an environment variable
+
+```bash
+export SPRING_PROFILES_ACTIVE=dev
+````
+
+```bash
+./mvnw spring-boot:run
+```
+or
+```bash
+./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
+```
+
+---
+
+### 4. Access API
+
+```text
+http://localhost:8080
+```
+
+---
+
+## 🔗 API Endpoints
+
+### ➕ Shorten URL
+
+```http
+POST /shorten
+```
+
+**Request:**
+
+```json
+{
+  "fullUrl": "https://example.com",
+  "customAlias": "my-alias"
+}
+```
+
+**Response (201):**
+
+```json
+{
+  "shortUrl": "http://localhost:8080/my-alias"
+}
+```
+
+---
+
+### 🔁 Redirect to Original URL
+
+```http
+GET /{alias}
+```
+
+**Response:**
+
+* `302 Found` → Redirects to original URL
+* `404 Not Found` → Alias does not exist
+
+---
+
+### 📋 Get All URLs
+
+```http
+GET /urls
+```
+
+**Response:**
+
+```json
+[
+  {
+    "alias": "my-alias",
+    "fullUrl": "https://example.com",
+    "shortUrl": "http://localhost:8080/my-alias"
+  }
+]
+```
+
+---
+
+### ❌ Delete URL
+
+```http
+DELETE /{alias}
+```
+
+**Response:**
+
+* `204 No Content` → Successfully deleted
+* `404 Not Found` → Alias not found
+
+---
+Access H2 console:
+
+```text
+http://localhost:8080/h2-console
+
+```
+
+## ⚙️ Profiles
+
+Run with different profiles:
+
+```bash
+java -jar app.jar --spring.profiles.active=dev
+```
+
+Available profiles:
+
+* `dev`
+* `test`
+---
+
+## 🧪 Running Tests
+
+### Unit tests
+
+```bash
+./mvnw test
+```
+
+### Integration tests
+
+```bash
+./mvnw verify
+```
+
+---
+
+## 📊 Code Coverage (JaCoCo)
+
+Generate report:
+
+```bash
+./mvnw clean verify
+```
+
+Open report:
+
+```text
+target/site/jacoco/index.html
+```
+---
+
+## 🐳 Docker
+
+### Build image
+
+```bash
+docker build -t url-shortener .
+```
+
+### Run the Container by passing spring profile dev
+
+```bash
+docker run -p 8080:8080 \
+  -e SPRING_PROFILES_ACTIVE=dev \
+  url-shortener
+```
+Note: I'm not pusing docker image to DockerHub. Please build image from the Dockerfile and create a container from the image
+## ⚠️ Common Issues
+
+### ❌ CORS errors
+
+Fix backend CORS configuration
+
+### ❌ Port already in use
+
+Change port:
+
+```yaml
+server:
+  port: 8081
+```
+
+### ❌ DB connection issues
+
+Check credentials and DB availability
+
+---
+
+## 💡 Future Improvements
+
+* URL expiration
+* Analytics (click tracking)
+* Reslience 4J
+* Authentication (JWT)
+* API Documentation
+* Redis cache integration
+* DB Migration
+* DB indexing
+
+---
+
+## Run frontend application
+
+1. Clone the repository
+   ```bash
+   git clone git@github.com:upendrakumbham/url-shortener-ui.git
+   cd url-shortener-ui
+   ```
+2. Install dependencies
+   npm install
+3. Start the development server
+   npm run dev
+4. Open the application
+   http://localhost:5173
+   🔗 Backend Configuration
+
+The frontend expects the backend API to be running at:
+http://localhost:8080
+
+If your backend runs on a different port, update:
+src/api/urlApi.js
+const API_BASE = "http://localhost:8080";
+
+### 🌐 CORS Configuration (IMPORTANT)
+```
+Update your Spring Boot backend:
+
+@CrossOrigin(origins = "http://localhost:5173")
+Public class UrlController
+Or configure globally via WebMvcConfigurer.
+Rerun backend API, make sure it is running.
+```
+###  🧪 Available Scripts
+```
+npm run dev       # Start dev server
+npm run build     # Build production bundle
+npm run preview   # Preview production build
+```
+
+## 🧑‍💻 Author
+
+Upendra Kumbham
+
+---
+
+## 📄 License
+
+This project is implemented as part TpxImpact assignment.
+
+
+
+
+
+
+
+

data/shortener_db.lock.db

@@ -0,0 +1,6 @@
+#FileLock
+#Tue Apr 28 09:34:49 BST 2026
+server=localhost\:55298
+hostName=localhost
+method=file
+id=19dd33a086929b0b0e6a6b57c1f5f73c27f988cf9af