An open API service indexing awesome lists of open source software.

https://github.com/ronilsonalves/5lnk

A URL shortener built in GoLang and TypeScript with Next.js
https://github.com/ronilsonalves/5lnk

backend frontend golang nextjs13 typescript url-shortener

Last synced: about 1 month ago
JSON representation

A URL shortener built in GoLang and TypeScript with Next.js

Awesome Lists containing this project

README

          

# 5lnk – URL Shortener

5lnk is a URL Shortener built in Golang with Next.js to be simple and faster. With endless possibilities coming.

## Table of contents
- [About](#about)
- [Tech Stack](#tech-stack)
- [Screenshots](#screenshots)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Licence](#license)

## About
This project started as a way to practice my Golang skills and learn more about TypeScript and new App Router from Next.js 13.
Currently, I'm working in new features such a page of links, theme and language selection – you can see more at the project [Roadmap](#roadmap).

## Tech Stack
### Backend Technologies
- Go Lang
- Gin Web Framework
- GORM
- PostgresSQL
- Redis
- Firebase Admin SDK
- Swag (Swagger 2.0)

### Frontend Technologies
- TypeScript
- Next.js
- TailwindCSS
- DaisyUI
- Contentlayer

### DevOps / Deploy
- Docker
- Fly.io
- Vercel

## Screenshots
>Home page: ![5lnk home page](home.jpeg)

> Login page: ![login page](login.jpeg)

> Register page: ![register page](register.jpeg)

>Dashboard: ![Dashboard page](frontend/public/screenshot-dev.png)

## Roadmap
Bellow you can see what is planned for future implementation.

- [ ] Change to server actions instead hooks.
- [x] Implement feat to allow users to build link pages.
- [ ] Implement alias for URL shortened
- [ ] Improve analytics system
- [x] Implement Theme switch
- [ ] Add internationalization
- [ ] Automatize the deployment to my kubernetes cluster.
- [ ] Add tests to the backend

## Contributing
Details soon

## License
Details soon