{"id":25931064,"url":"https://github.com/msparihar/shortify","last_synced_at":"2026-04-15T19:40:27.471Z","repository":{"id":280237878,"uuid":"941219426","full_name":"Msparihar/shortify","owner":"Msparihar","description":"A modern, high-performance URL shortener built with Next.js 14 \u0026 FastAPI. Features Redis caching, real-time analytics, and a beautiful UI powered by shadcn/ui. Fully dockerized and production-ready.","archived":false,"fork":false,"pushed_at":"2025-03-02T06:47:01.000Z","size":178,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T07:27:23.302Z","etag":null,"topics":["fastapi","mongodb","nextjs","redis","url-shortener"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Msparihar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-01T19:16:25.000Z","updated_at":"2025-03-02T06:47:05.000Z","dependencies_parsed_at":"2025-03-02T07:37:31.774Z","dependency_job_id":null,"html_url":"https://github.com/Msparihar/shortify","commit_stats":null,"previous_names":["msparihar/shortify"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fshortify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fshortify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fshortify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Msparihar%2Fshortify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Msparihar","download_url":"https://codeload.github.com/Msparihar/shortify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241758971,"owners_count":20015247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","mongodb","nextjs","redis","url-shortener"],"created_at":"2025-03-03T23:57:20.147Z","updated_at":"2026-04-15T19:40:27.423Z","avatar_url":"https://github.com/Msparihar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shortify - Modern URL Shortener\n\nShortify is a modern, high-performance URL shortener built with FastAPI, React, and Redis. It features real-time click tracking, caching, and a beautiful responsive UI.\n\n![Shortify Demo](assets/images/demo.png)\n\n## Features\n\n- ⚡️ **High Performance**: Redis caching and async operations\n- 🎯 **Real-time Analytics**: Track clicks and usage statistics\n- 🎨 **Modern UI**: Beautiful, responsive interface built with React and Tailwind\n- 🔒 **Secure**: Input validation and rate limiting\n- 📊 **Cache Management**: Efficient caching with Redis\n- 🚀 **Scalable**: Designed for high traffic with background tasks\n\n## Tech Stack\n\n### Backend\n\n- FastAPI (Python 3.12+)\n- MongoDB with Motor\n- Redis for caching\n- Background tasks for analytics\n\n### Frontend\n\n- React 18\n- Next.js 14\n- Tailwind CSS\n- Shadcn UI\n- React Query\n\n## Quick Start\n\n### Prerequisites\n\n- Python 3.12+\n- Node.js 18+\n- MongoDB\n- Redis\n- pnpm (recommended) or npm\n\n### Backend Setup\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/yourusername/shortify.git\n   cd shortify\n   ```\n\n2. Set up the backend:\n\n   ```bash\n   cd backend\n   python -m venv .venv\n   source .venv/bin/activate  # On Windows: .venv\\Scripts\\activate\n   pip install -r requirements.txt\n   ```\n\n3. Configure environment variables:\n\n   ```bash\n   cp .env.example .env\n   # Edit .env with your configuration\n   ```\n\n4. Run the backend:\n\n   ```bash\n   uvicorn main:app --reload\n   ```\n\n### Frontend Setup\n\n1. Install dependencies:\n\n   ```bash\n   cd frontend\n   pnpm install\n   ```\n\n2. Configure environment variables:\n\n   ```bash\n   cp .env.example .env.local\n   # Edit .env.local with your configuration\n   ```\n\n3. Run the development server:\n\n   ```bash\n   pnpm dev\n   ```\n\nVisit `http://localhost:3000` to see the application.\n\n## Development\n\n### Backend Development\n\nThe backend is structured as follows:\n\n```\nbackend/\n├── app/\n│   ├── api/        # API routes\n│   ├── core/       # Core functionality\n│   ├── db/         # Database clients\n│   └── models/     # Pydantic models\n├── tests/          # Test files\n└── main.py         # Application entry\n```\n\n### Frontend Development\n\nThe frontend follows Next.js 14 conventions:\n\n```\nfrontend/\n├── app/            # Next.js app router\n├── components/     # React components\n├── lib/           # Utilities and hooks\n└── public/        # Static assets\n```\n\n## API Documentation\n\nAPI documentation is available at `http://localhost:8000/docs` when running the backend server.\n\n### Key Endpoints\n\n- `POST /api/shorten` - Create shortened URL\n- `GET /api/urls` - List all URLs\n- `GET /{short_code}` - Redirect to original URL\n\n## Deployment\n\n### Docker Deployment\n\n1. Build the images:\n\n   ```bash\n   docker-compose build\n   ```\n\n2. Run the stack:\n\n   ```bash\n   docker-compose up -d\n   ```\n\n### Manual Deployment\n\nSee [DEPLOYMENT.md](docs/DEPLOYMENT.md) for detailed deployment instructions.\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [FastAPI](https://fastapi.tiangolo.com/)\n- [Next.js](https://nextjs.org/)\n- [Shadcn UI](https://ui.shadcn.com/)\n- [Tailwind CSS](https://tailwindcss.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsparihar%2Fshortify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsparihar%2Fshortify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsparihar%2Fshortify/lists"}