Skip to content

Shortify is a simple URL shortener web application built using Next.js and Tailwind CSS

Notifications You must be signed in to change notification settings

snoofox/Shortify

Repository files navigation

Shortify URL Shortener

Shortify is a simple URL shortener web application built using Next.js and Tailwind CSS. It allows users to shorten long URLs into shorter, more manageable links.

Features

  • Shorten long URLs into short, easy-to-share links
  • Customizable short link aliases
  • Copy shortened links to the clipboard with one click
  • Responsive design for optimal usage on various devices

Preview

Installation

  1. Clone the repository:

    git clone https://github.com/snoofox/shortify.git
  2. Navigate to the project directory:

     cd shortify
  3. Install the dependencies:

     npm install
  4. Start the development server:

     npm run dev
  5. Open your browser and visit http://localhost:3000 to access the Shortify

Configuration

Shortify requires some environment variables to be set for proper functioning. Create a .env.local file in the project root and define the following variables:

MONGO_URI=MONGODB_URI
NEXT_PUBLIC_API_URL=YOUR_SITE_URL
NEXTAUTH_SECRET=RANDOM_SECRET_KEY

Technology Used

  • Next.js - React framework for server-rendered applications
  • Tailwind CSS - Utility-first CSS framework
  • Axios - Promise-based HTTP client for making API requests
  • MongoDB - NOSQL Database

Contributing

Contributions to the Shortify are always welcome! If you find any bugs or have suggestions for improvements, please submit an issue or open a pull request.

License

MIT License

Copyright (c) 2023

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Thanks For Visiting

Hope you liked it. Wanna support?

About

Shortify is a simple URL shortener web application built using Next.js and Tailwind CSS

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published