Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.29 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.29 KB
Raw

Linkee 🔗

Linkee is a dynamic and versatile open-source URL shortening web application designed for self-hosting. With its powerful API and user-friendly interface, Linkee empowers you to create and manage your own branded URL shortener, giving you complete control over your links and data. Offering a seamless user experience and customizable themes, Linkee ensures a modern and visually appealing platform for all your URL shortening needs.

Installation

  1. Clone the Linkee repository from the GitHub page:
git clone https://github.com/abhint/linkee.git
  1. Navigate to the project:
cd linkee
  1. Run the following command to install the dependencies:
go mod download
  1. Customize the configuration file located at config.yaml to suit your needs.
# sample

databaseConfig:
  dataSourceName: linkee.db

hostConfig:
  host: localhost
  port: 5000
  1. Build the project using the following command:
go build -o linkee
  1. Run the Linkee server:
./linkee

Contribution

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on the GitHub repository.

License

This package is released under the MIT License. See the LICENSE file for more details.