Skip to content

art3m4ik3/shrtx

Repository files navigation

Shrtx - Modern URL Shortener

🚀 Key Features

  • URL Shortening with customizable length
  • Custom Aliases for creating memorable short links
  • Link Expiration by date or number of clicks
  • Analytics to track the effectiveness of your links
  • Dashboard for monitoring all your shortened URLs
  • Dark and Light Themes for comfortable use

🛠️ Technologies

🚦 Getting Started

Prerequisites

  • Node.js (version 18 or higher)
  • Bun or npm
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/art3m4ik3/shrtx.git
    cd shrtx
  2. Install dependencies:

    bun install
    # or
    npm install
  3. Create a .env.local file and configure the necessary environment variables:

    MONGODB_URI=mongodb://127.0.0.1:27017
    
  4. Run the project in development mode:

    bun run dev
  5. Open http://localhost:3000 in your browser.

About

Moder URL Shortener

Topics

Resources

License

Stars

Watchers

Forks