Skip to content

NanoLink is a robust URL shortening platform built with the MERN stack and Next.js, offering streamlined link management, custom aliases, and detailed analytics.

Notifications You must be signed in to change notification settings

Krish-Makadiya/Nano.Link

Repository files navigation

NanoLink

NanoLink is a powerful URL shortening platform designed to simplify link management and optimize sharing. Built with the MERN stack (MongoDB, Express.js, React.js, and Node.js) and enhanced by Next.js, NanoLink delivers a robust, scalable, and responsive user experience.


Features

  • URL Shortening: Generate compact, shareable links.
  • Custom Aliases: Create personalized short URLs.
  • Analytics Dashboard: Track link performance with detailed metrics.
  • Responsive Design: Optimized for all devices.
  • Secure Links: Ensure the safety and validity of shortened links.

Tech Stack

Frontend

  • Framework: React.js
  • Styling: Tailwind CSS
  • Enhancements: Next.js

Backend

  • Server: Express.js
  • Database: MongoDB
  • Node.js: Server-side JavaScript runtime

Hosting

  • Frontend and backend hosted on platforms like Vercel, Heroku, or AWS.

Installation

Prerequisites

  • Node.js (version 16+)
  • npm or yarn
  • MongoDB instance

Steps

  1. Clone the repository:

    git clone https://github.com/yourusername/nanolink.git
    cd nanolink
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Create a .env file in the root directory and add the following environment variables:

    MONGO_URI=your_mongodb_connection_string
    NEXT_PUBLIC_BASE_URL=your_base_url
    JWT_SECRET=your_jwt_secret
  4. Start the development server:

    npm run dev
    # or
    yarn dev
  5. Open http://localhost:3000 in your browser to view the application.


Usage

  1. Shorten URLs effortlessly.
  2. Access the analytics dashboard to monitor link performance.
  3. Share customized short links securely and effectively.

Contributing

Contributions are welcome! Follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:
    git commit -m "Add a meaningful commit message"
  4. Push to your branch:
    git push origin feature/your-feature-name
  5. Create a Pull Request.

Acknowledgements


Contact

For queries or suggestions, feel free to contact:


Releases

No releases published

Packages

No packages published