Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Binary file added docs/images/admin_dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/qr_code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/register.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/shorten_url_and_link_management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/swagger_ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/vip_packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/vnpay_payment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</parent>
<groupId>com.tlavu</groupId>
<artifactId>linkforge</artifactId>
<version>0.0.1-SNAPSHOT</version>
<version>1.0.0</version>
<name>linkforge</name>
<description>URL Shortener powered by Spring Boot</description>
<url/>
Expand Down
Loading