Linkly is a user-friendly, feature-rich link shortener app designed to simplify and enhance your URL management experience. With Linkly, you can easily generate short, shareable links and customize them to suit your needs.
- Shorten Long URLs: Instantly create compact, shareable links for long and complex URLs.
- Customizable URLs: Add a personal touch by customizing the alias of your shortened links.
- Mobile-Friendly Design: Fully responsive interface, accessible on all devices.
Follow these steps to install and run Linkly:
- Node.js (v14.0.0 or higher)
- npm package manager
- A MongoDB instance (local or cloud-based)
-
Clone the Repository:
git clone https://github.com/username/linkly.git cd linkly
-
Install Dependencies:
npm install
-
Set Up Environment Variables:
- Create a
.env
file in the root directory and add the following:MONGO_URI=<your-mongodb-connection-string> NEXT_PUBLIC_HOST=https:localhost:3000
- Create a
-
Run the Application:
- Development Mode:
npm run dev
- Production Mode:
npm run start
- Development Mode:
-
Access the App:
- Open your browser and navigate to
http://localhost:3000
.
- Open your browser and navigate to
Shorten a URL:
- Enter the long URL in the input field and click Shorten.
- Copy and share your new shortened link.
We welcome contributions from the community! To contribute:
- Fork the repository.
- Create a feature branch:
git checkout -b feature/new-feature
- Commit your changes:
git commit -m "Add new feature"
- Push to your branch:
git push origin feature/new-feature
- Submit a pull request.
This project is licensed under the MIT License.
For support or inquiries, feel free to reach out:
- Github: Linkly