The ultimate open-source tool for creating, managing, and sharing shortened links.
🌟 ## Overview
LinkForge is a web application designed to solve the problem of long, unwieldy URLs. Whether you're a developer, a marketer, or just someone who wants to manage links more effectively, LinkForge provides the tools you need to create clean, trackable, and professional-looking links.
✨ ## Features
- 🔗 Link Shortening: Create clean, short, and memorable links from long URLs.
- 📊 Analytics Dashboard: Track click-through rates, referral sources, and geographic data.
- 🚀 Fast & Lightweight: Built for performance and a smooth user experience.
🛠️ ## Technologies Used
- Frontend: [React + Vite]
- Backend: Spring Boot, [Java 17+]
- Database: [PostgreSQL]
- Deployment: [Docker, Render, Netlify]
- Other: [Maven, Lombok, JWT]
🚀 ## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
Make sure you have the following installed on your system:
- [Java (v17 or later)]
- [Maven]
- [Node.js (v18.x or later)]
- [npm]
- [Git]
-
Clone the repository:
git clone [https://github.com/kmanish527/LinkForge.git](https://github.com/kmanish527/LinkForge.git) cd linkforge -
Install frontend dependencies:
# Navigate to your frontend directory # cd linkforge-frontend npm install
-
Set up environment variables: Create a
.envfile in the root/frontend directory and add the necessary configuration. Copy the example file to get started:cp .env.example .env
Now, open
.envand fill in your details (e.g., VITE_BACKEND_URL, VITE_REACT_FRONT_END_URL). -
Run the application:
-
Backend (Spring Boot):
-
Using the command line: Navigate to the backend directory and run the following command to start the server:
./mvnw spring-boot:run
or
-
Using IntelliJ IDEA:
- Open IntelliJ IDEA.
- Select
File > Open...and navigate to the root directory of the backend project. - Allow IntelliJ to import the project and resolve Maven dependencies.
- Locate the main application class (e.g.,
LinkforgeBackendApplication.java). - Right-click on the file and select
Run 'LinkforgeBackendApplication'.
The backend server should now be running on
http://localhost:8081.
-
-
Frontend: In a separate terminal, navigate to the frontend directory and run:
npm run dev
The frontend application should now be running on
http://localhost:5173.
-




