Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ksh168/url_shortener_java

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/ksh168/url_shortener_java
Owner: ksh168
Created: 2024-03-02T20:27:03.000Z (10 months ago)
Default Branch: master
Last Pushed: 2024-11-27T19:51:27.000Z (about 1 month ago)
Last Synced: 2024-11-27T20:33:55.336Z (about 1 month ago)
Language: Java
Size: 51.8 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# URL Shortener Service

A robust URL shortening service built with Spring Boot that converts long URLs into short, manageable links.

## Features

- URL Shortening: Convert long URLs into short, unique identifiers
- URL Redirection: Redirect users from short URLs to original long URLs
- Persistence: Store URL mappings in a database
- Logging: Record access history
- RESTful API: Simple and intuitive API endpoints

## Technologies Used

- Java 17
- Spring Boot
- Spring Data JPA
- H2 Database (can be configured for other databases)
- Gradle
- RESTful APIs

## Prerequisites

- Java 17 or higher
- Gradle 7.x or higher

## Getting Started

1. Clone the repository:
```bash
git clone https://github.com/yourusername/url_shortener_java.git
cd url_shortener_java
```

2. Build the project:
```bash
./gradlew build
```

3. Run the application:
```bash
./gradlew bootRun
```

The application will start on `http://localhost:8080`

## Configuration

The application can be configured through `src/main/resources/application.properties`. Key configurations include:

- Server port
- Database settings
- URL shortening settings

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request