Skip to content

Muhammad-Zain01/url-shortner

Repository files navigation


URL Shortner (Client)

A simple and efficient URL shortener that allows you to create shortened versions of long URLs, making them easier to share and manage. This URL shortener (Client) is built with React.js (Vite). It provides a clean and user-friendly interface for both shortening and expanding URLs.

Explore the docs »

View Demo - Backend Repo


Product Name Screen Shot Product Name Screen Shot

Credentials for Testing

Username Password
test test123

Built With

  • React

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/muhammad-zain01/url-shortner.git
  2. Install NPM packages

     cd url-shortner
     npm install
  3. Creating .env

     VITE_SERVER_URL=<BACKEND_URL>
     VITE_DOMAIN_URL=<FRONTEND_URL>
  4. For Starting Server

    npm run dev

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

About

A simple and efficient URL shortener that allows you to create shortened versions of long URLs, making them easier to share and manage.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages