diff --git a/README.md b/README.md index 982258b..ac959fd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ +# LinkForge - Powerful URL Shortener & Link Management + LinkForge is a full-featured URL shortening and link management platform built with **Java 21** and **Spring Boot 3**. It's designed with a **Headless Backend Architecture** — providing the core API and infrastructure (Database + Caching) as a single bundled unit, ready for integration with any frontend. -![Dashboard Overview](docs/images/dashboard_overview.png) +![Overview](docs/images/overview.png) > [!NOTE] > This is a **Full Backend Infrastructure Bundle** (REST API + PostgreSQL + Redis). @@ -180,7 +182,7 @@ cp .env.example .env # Edit .env and fill in your JWT_SECRET_KEY and other required values. # Option B: Download pre-configured files -# Download .env or .env.prod from [Google Drive Link](LINK_DRIVE_HERE) +# Download .env or .env.prod from "Backend" folder of this [Google Drive Link](https://drive.google.com/drive/folders/13TrE4vfyboF2OTSe6Yj7t_SanFauAyhV?usp=sharing) # and save it to the project root. # 3. Start everything @@ -199,7 +201,7 @@ docker compose up -d postgres redis # 2. Get environment file # Option A: cp .env.example .env && (Configure .env) -# Option B: Download from [Google Drive](LINK_DRIVE_HERE) to the project root. +# Option B: Download from "Backend" folder of this [Google Drive Link](https://drive.google.com/drive/folders/13TrE4vfyboF2OTSe6Yj7t_SanFauAyhV?usp=sharing) to the project root. # 3. Run the application mvn spring-boot:run @@ -227,7 +229,7 @@ Usage: You have two ways to configure your environment: 1. **Manual**: Copy `.env.example` to `.env` and fill in the required values. -2. **Download**: Get pre-configured `.env` (Dev) and `.env.prod` (Production) files from this **[Google Drive Link](LINK_DRIVE_HERE)**. +2. **Download**: Get pre-configured `.env` (Dev) and `.env.prod` (Production) files from "Backend" folder of this **[Google Drive Link](https://drive.google.com/drive/folders/13TrE4vfyboF2OTSe6Yj7t_SanFauAyhV?usp=sharing)**. > [!IMPORTANT] > Always ensure your `.env` file is in the root directory before running the application or Docker. @@ -316,14 +318,14 @@ The frontend repository includes a `vercel.json` for deployment to Vercel. See t 2. Optionally set a **custom alias** and **expiration date**. 3. Click **Shorten** — your new short link and **delete token** are displayed immediately. -![Shorten URL](docs/images/shorten_url.png) +![Shorten URL](docs/images/shorten_url_and_link_management.png) ### Link Management Dashboard 1. Navigate to **My Links** to view all your created links. 2. Use **search**, **sort**, and **pagination** to find specific links. 3. **Delete** links or **generate QR codes** (VIP/Admin) directly from the table. -![Link Management](docs/images/link_management.png) +![Link Management](docs/images/shorten_url_and_link_management.png) ### QR Code Generation (VIP / Admin) 1. Open any link from your dashboard. diff --git a/docs/images/admin_dashboard.png b/docs/images/admin_dashboard.png new file mode 100644 index 0000000..3e77708 Binary files /dev/null and b/docs/images/admin_dashboard.png differ diff --git a/docs/images/login.png b/docs/images/login.png new file mode 100644 index 0000000..b90dd16 Binary files /dev/null and b/docs/images/login.png differ diff --git a/docs/images/overview.png b/docs/images/overview.png new file mode 100644 index 0000000..a2dc354 Binary files /dev/null and b/docs/images/overview.png differ diff --git a/docs/images/qr_code.png b/docs/images/qr_code.png new file mode 100644 index 0000000..6adef22 Binary files /dev/null and b/docs/images/qr_code.png differ diff --git a/docs/images/register.png b/docs/images/register.png new file mode 100644 index 0000000..bcdef5c Binary files /dev/null and b/docs/images/register.png differ diff --git a/docs/images/shorten_url_and_link_management.png b/docs/images/shorten_url_and_link_management.png new file mode 100644 index 0000000..8e9c224 Binary files /dev/null and b/docs/images/shorten_url_and_link_management.png differ diff --git a/docs/images/swagger_ui.png b/docs/images/swagger_ui.png new file mode 100644 index 0000000..4c0a186 Binary files /dev/null and b/docs/images/swagger_ui.png differ diff --git a/docs/images/vip_packages.png b/docs/images/vip_packages.png new file mode 100644 index 0000000..be277bf Binary files /dev/null and b/docs/images/vip_packages.png differ diff --git a/docs/images/vnpay_payment.png b/docs/images/vnpay_payment.png new file mode 100644 index 0000000..cc46741 Binary files /dev/null and b/docs/images/vnpay_payment.png differ diff --git a/pom.xml b/pom.xml index fcaf8b2..e3953b7 100644 --- a/pom.xml +++ b/pom.xml @@ -10,7 +10,7 @@ com.tlavu linkforge - 0.0.1-SNAPSHOT + 1.0.0 linkforge URL Shortener powered by Spring Boot