BitBuddy is a delightful and user-friendly URL shortener built with React, Tailwind CSS, React Router DOM, and Toastify on the frontend, and Node.js, TypeScript, and Yup on the backend. It allows you to shorten long URLs into neat and memorable links, making sharing and managing links a breeze!
- URL Shortening: Quickly transform long URLs into short, concise links.
- Validates URL: Validates URL before shortening it.
- Copy to Clipboard: Easily copy shortened links to your clipboard with just a click.
- Animations: Behold the animated loader, gracefully spinning and swirling, as your web page prepares to captivate your senses.
- Stores History: Stores History of your previous shortend URLs.
- Error Page: Displays an error page if URL is not available.
- Responsive Design: Enjoy a seamless experience across various devices, including desktops, tablets, and mobile phones.
- Customize URLs: Personalize your shortened links with custom aliases or let BitBuddy generate unique ones for you.
- Link Analytics: Gain insights into link performance with detailed analytics, including clicks, referrals, and geographic data.
- QR Code Generation: Generate QR codes for your shortened links, making it easy for users to scan and access your content.
To run BitBuddy locally, follow these steps:
- Clone the repository:
git clone https://github.com/divyanshu1810/bitbuddy.git - Navigate to the project directory:
cd bitbuddy - Install dependencies for the frontend:
cd frontend yarn install - Install dependencies for the backend:
cd ../backend yarn install - Start the development server:
This will start the React development server for the frontend.
cd ../frontend yarn run start - In a new terminal, start the backend server:
This will start the backend server using nodemon for automatic reloading.
cd ../backend yarn run dev
Make sure you have Node.js and npm installed on your system before running the commands.
- React
- Tailwind CSS
- React Router DOM
- Toastify
- Node.js
- TypeScript
- Yup
We welcome contributions to BitBuddy! If you find a bug or have a feature request, please open an issue on the GitHub repository. Pull requests are also encouraged.
Please ensure that your code follows the established coding style and conventions. Include tests for any new functionality or bug fixes.
This project is licensed under the MIT License. See the LICENSE file for more information.
We would like to express our gratitude to the following libraries and frameworks for making BitBuddy possible:
Special thanks to the open-source community for their invaluable contributions.
Have questions, suggestions, or just want to say hi? Feel free to reach out to us at contact@devyansh.me. We'd love to hear from you!
Let's make