A clean, responsive, and developer-friendly link shortener experience built with modern web tooling.
Overview • Features • Tech Stack • Project Structure • Getting Started • Documentation
Shorty is a URL shortener application focused on speed, simplicity, and presentation quality. It converts long links into short, shareable URLs while maintaining a smooth user experience and clean UI.
This branch (next_migration) represents the migration toward a Next.js-based architecture, improving maintainability, routing consistency, and developer experience.
- Shorten long URLs into compact, shareable links
- Fast and intuitive link creation flow
- Clear input-to-output UX with minimal friction
- Modern and polished interface
- Responsive layout for desktop, tablet, and mobile
- Readable structure and consistent spacing/typography
- User-centric workflow with straightforward interactions
- Migration to Next.js App Router conventions
- Better project organization for scalability
- Production-ready structure for future enhancements
| Layer | Technology |
|---|---|
| Framework | Next.js |
| Languages | JavaScript, TypeScript |
| Styling | CSS |
| Markup | HTML |
| Runtime / Tooling | Node.js, npm |
Repository language composition: JavaScript (90.2%), CSS (6.1%), TypeScript (3.5%), HTML (0.2%).
Shorty/
├── app/ # Next.js App Router pages and layouts
├── public/ # Static assets
├── styles/ or *.css # Global/component styles
├── package.json # Scripts and dependencies
└── README.md # Project overview (this file)
Note: Folder names can vary slightly as migration progresses.
git clone https://github.com/Gavinduachintha/Shorty.git
cd Shortygit checkout next_migrationnpm installnpm run devOpen http://localhost:3000 in your browser.
| Command | Description |
|---|---|
npm run dev |
Start local development server |
npm run build |
Build app for production |
npm run start |
Run the production build |
npm run lint |
Run linting checks |
This front-page README is intended for quick orientation. For deeper technical docs, you can add:
docs/ARCHITECTURE.md— system design and module flowdocs/API.md— endpoint contracts and payload examplesdocs/DEPLOYMENT.md— environment and deployment guidedocs/CONTRIBUTING.md— contribution workflow and coding standards
If you want, I can generate these files next in the same UI style.
Contributions are welcome.
- Fork the repo
- Create a feature branch
- Commit your changes
- Open a Pull Request
Add your license details here (e.g., MIT License).
Gavindu Achintha
GitHub: @Gavinduachintha