LINKLY is a URL Shortener system that simplifies long URLs into short, manageable links. It offers additional features like custom alias options, an analytics dashboard, and a user-friendly interface to track and manage shortened links efficiently.
- URL Shortening: Convert long URLs into short, easy-to-share links.
- Custom Aliases: Allow users to create personalized aliases for their shortened URLs.
- Analytics Dashboard: Track click statistics and usage metrics for each shortened link.
- Searchable Dashboard: Manage and search for your shortened links quickly and efficiently.
- Responsive Design: Ensures a seamless experience on both desktop and mobile devices.
- React.js: For building an interactive and responsive user interface.
- JavaScript: For dynamic functionality and real-time updates.
- HTML, CSS: For structuring and styling the application.
- Node.js & Express.js: For developing a robust and scalable server-side application.
- MongoDB: For storing URLs, aliases, and click data securely.
- Node.js installed on your system.
- MongoDB database set up and running.
-
Clone the repository:
git clone https://github.com/DeepakGaut/LINKLY.git
-
Navigate to the project directory:
cd LINKLY -
Install dependencies for the frontend:
cd frontend npm install -
Install dependencies for the backend:
cd ../backend npm install -
Configure environment variables:
- Create a
.envfile in thebackenddirectory and add your MongoDB connection string and other necessary variables.
- Create a
-
Start the application:
- Start the backend:
npm start
- Start the frontend:
cd ../frontend npm start
- Start the backend:
- Open your browser and go to
http://localhost:3000to access the application.
LINKLY
├── frontend
│ ├── public
│ └── src
│ ├── components
│ ├── pages
│ └── styles
├── backend
│ ├── models
│ ├── routes
│ ├── controllers
│ └── utils
└── README.md
Contributions are welcome! If you'd like to contribute, please fork the repository and create a pull request with your proposed changes.
For any inquiries, please reach out to Deepak Gautam at [email protected].