bitmutex/URLShortener
1
0
Fork 0
Code Issues Pull requests Projects Releases 4 Packages Wiki Activity Actions
A powerful and scalable URL shortener with integrated bio pages built using Spring Boot.
6 commits 1 branch 4 tags 132 MiB
HTML 44.6%
Java 42.4%
JavaScript 6.5%
CSS 2.5%
TypeScript 1.2%
Other 2.8%
Find a file
Amit Kumar Nandi 9530616656 CircleCI Commit
2024-02-02 00:32:32 +05:30
.circleci CircleCI Commit 2024-02-02 00:32:32 +05:30
.mvn/wrapper t 2024-02-01 23:44:46 +05:30
logs t 2024-02-01 23:44:46 +05:30
src t 2024-02-01 23:44:46 +05:30
test-output t 2024-02-01 23:44:46 +05:30
.gitignore t 2024-02-01 23:44:46 +05:30
create.sql t 2024-02-01 23:44:46 +05:30
image.png t 2024-02-01 23:44:46 +05:30
mvnw t 2024-02-01 23:44:46 +05:30
mvnw.cmd t 2024-02-01 23:44:46 +05:30
pom.xml t 2024-02-01 23:44:46 +05:30
README.md Update README.md 2024-02-02 00:19:10 +05:30
shortener_db_schema.sql t 2024-02-01 23:44:46 +05:30
testng.xml t 2024-02-01 23:44:46 +05:30

README.md

Enterprise-Grade URL Shortener and Bio Page Application

Build Status License GitHub last commit GitHub issues GitHub pull requests GitHub contributors Twitter

A powerful and scalable URL shortener with integrated bio pages built using Spring Boot.

Table of Contents

Overview

This project is an enterprise-grade URL shortener and bio page application developed with Spring Boot. It provides a robust solution for shortening URLs and creating bio pages for users. The application is designed for scalability and includes features such as analytics, user management, and subscription plans.

Features

  • Shorten URLs and create custom short URLs
  • Integrated bio pages for users
  • Analytics tracking for each shortened URL
  • User management with registration, login, and profile updates
  • Subscription plans for premium features
  • Rate limiting to prevent abuse
  • Forgot password and username recovery functionality
  • ...

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Java (JDK 11 or later)
  • Maven
  • MySQL
  • Your favorite IDE (IntelliJ, Eclipse, etc.)

Local Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/your-repo.git

  2. Create a MySQL database:

    CREATE DATABASE url_shortener_db;

  3. Update the application.properties file:

Update the application.properties file in the src/main/resources directory with your database configuration.

  1. Build and run the application:

       Ccd your-repo
   mvn spring-boot:run

  2. Access the application at http://localhost:8080

Deployment

  1. Build a deployable JAR:

    mvn clean install

  2. Deploy the JAR:

Deploy the generated JAR file to your cloud provider of choice (AWS, GCP, Azure, etc.).

3.Configure environment variables:

Set environment variables for cloud-specific settings.

  1. Start the application on the cloud server:

    java -jar your-repo.jar

Usage

  1. Shorten URLs by visiting the URL Shortener page.
  2. Access analytics for each shortened URL.
  3. Create and manage bio pages in the Bio section.

Contributing

Contributions are welcome! Please follow the contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.