_      _   _ _  _______  
 | |    | \ | | |/ /  __ \ 
 | |    |  \| | ' /| |  | |
 | |    | . ` |  < | |  | |
 | |____| |\  | . \| |__| |
 |______|_| \_|_|\_\_____/ 
                           

LNKD is a self-hosted shortlink and monitor service designed to simplify your link management while providing valuable insights. Our goal is to offer a lightweight, flexible, and privacy-focused alternative to commercial URL shorteners.

• About LNKD
• Repositories
• Features
• Getting Started
• Contributing
• License
• Contact

LNKD (pronounced “linked”) was created to:

1. Shorten your links in a blink
2. Ping and verify link uptime and status
3. Provide insightful analytics without compromising privacy

Below is an overview of the main repositories under the LNKD organization:

• Shortlink Management:
  Quickly create, update, and delete shortlinks.

• Monitoring:
  Periodically ping targets to track availability and response times.

• Analytics & Insights:
  Check how often your shortlinks are clicked and how they perform.

• Privacy-Focused:
  Minimal data storage—no hidden tracking or bloat.

• Flexible Architecture:
  Deploy on any cloud or self-host on bare metal servers.

1. Clone the Repositories

   git clone https://github.com/lnkd/lnkd-backend.git
   git clone https://github.com/lnkd/lnkd-frontend.git

2. Configure Environment

   • Rename .env.example to .env in both the backend and frontend.
   • Update variables like database credentials, service ports, etc.

3. Run Services TBI (to be implemented)

   • Docker Compose (recommended):

     cd lnkd-devops
     docker-compose up -d

   • Local Setup (Node.js, etc.): TBI (to be implemented)

4. Access LNKD TBI (to be implemented)

   • Open your browser at http://localhost:<FRONTEND_PORT>
   • Start shortening links and see them in action!

For more details, check out the lnkd-docs.

We welcome contributions from everyone! To get started:

1. Fork the relevant repo
2. Create a new branch for your feature or fix
3. Commit and push your changes
4. Open a Pull Request explaining what you did

For more details, see our CONTRIBUTING.md (if available).

LNKD is released under the MIT License.
Feel free to modify, distribute, and use it—just keep the original license notices intact.

• GitHub Issues: Create a ticket in the relevant repo
• Email: [email protected] (placeholder)
• Community Forum: Coming soon!

Stay tuned for updates and let us know how you’re using LNKD! Feedback, suggestions, and code contributions are always appreciated.