Shawty is a powerful URL shortener that not only shortens links but also provides rich analytics, QR code generation, and other advanced features. Built to integrate standard pages for GitHub, LeetCode, and Codeforces data, it also includes a UI interface to showcase user resumes.
- URL Shortening: Generate short links for any URL.
- Analytics Dashboard: Tracks:
- Number of clicks
- Device breakdown (e.g., tablets)
- Real-time graphs for visual insights
- Standard Pages:
- GitHub data visualization
- LeetCode statistics
- Codeforces performance insights
- QR Code Generation: Quickly generate QR codes for shortened URLs.
- Resume Viewer: Interactive UI to showcase resumes.
- Live Demo: Try it live here.
- Working Demo Video: Watch the demo here.
- Node.js (v16 or higher)
- npm or Yarn
-
Clone the Repository:
git clone https://github.com/ManashAnand/Shawty.git cd Shawty -
Install Dependencies:
npm install
-
Run the Development Server:
npm run dev
-
Build the Project:
npm run build
-
Start the Production Server:
npm start
To test changes locally, use the following command:
npm run devThis starts a local development server and watches for file changes.
Shawty/
├── Wrapper/ # Added TanStack and Supabase signup
├── actions/ # Added GitHub functionality
├── app/ # Rectify small bug
├── components/ # Added Codeforces widget
├── hooks/ # Added Bento grid
├── lib/ # Added some components
├── public/ # Added some components
├── utils/
│ └── supabase/ # Made template
├── .dockerignore # Rectify small bug
├── .eslintrc.json # Initial commit from Create Next App
├── .gitignore # Rectify small bug
├── Dockerfile # Rectify small bug
├── README.md # Initial commit from Create Next App
├── components.json # Added some components
├── next.config.mjs # Added Bento grid
├── package-lock.json # Added repo component
├── package.json # Added repo component
├── postcss.config.mjs # Initial commit from Create Next App
├── tailwind.config.ts # Added a cool look to it
└── tsconfig.json # Added TanStack and Supabase signup
- Graphs and Insights:
- Real-time updates on clicks and devices
- Interactive charts for easy analysis
- Custom Analytics: Detailed breakdown for user-generated links.
Contributions are welcome! Here's how you can contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature
- Commit your changes:
git commit -m "Add your feature" - Push to the branch:
git push origin feature/your-feature
- Create a Pull Request.
This project is licensed under the MIT License.
If you encounter any issues or have questions, feel free to open an issue or reach out.