🔗 Go Shorter

This project involves creating a basic URL shortener using Go and Redis. The purpose is to convert lengthy URLs into shorter links, exploring key concepts of web development, API handling, and database management.

You can use this project to learn, explore, and implementing the technical concepts and best practices of web development using Go.

💡 This project may not be the best way to create a URL shortener. The main idea of this project is to learn and explore the concepts of web development, API handling, and database management using Go.

🎯 The primary goal of this project is to assess and contrast the performance of the API under two conditions: with and without Redis caching.

💬 Feel free to open an issue or a pull request if you have any ideas or suggestions. Contributions are always welcome.

Features

• ✅ Store the shortened URLs in MongoDB
• ✅ Redirect to the original URL
• ✅ Get all the shortened URLs information
• ✅ Get a single shortened URL information
• ❌ Delete a single shortened URL
• ❌ Cache the shortened URLs in Redis
• ❌ Add a simple web interface
• ❌ Store the statistics of the shortened URLs
• ❌ Add a simple Dockerfile
• ❌ Create toggle to enable/disable the URL shortener
• ❌ Create toggle to enable/disable caching in Redis

✅: Completed | ❌: Not Implemented | ⚒️: In Progress

Technologies and Libraries

• GO - Main programming language used to build the API
• MongoDB - Database to store the shortened URLs
• Redis - Database to cache the shortened URLs
• Gin - HTTP web framework written in Go to build the API
• Mongo-go-driver - MongoDB driver for Go
• Viper - Go configuration library

Project Structure

.
├── LICENSE
├── README.md
├── controller
│   └── ... (controllers)
├── dev-logs.yml
├── go.mod
├── go.sum
├── main.go
├── model
│   └── ... (models)
├── router
│   └── ... (routers)
└── util
    └── ... (utilities)

Directory	Description
controller	Contains the controllers of the API
model	Contains the models of the API
router	Contains the routers of the API
util	Contains the utilities of the API

System Architecture

Will be added soon

Contribution

If you have any ideas or suggestions, feel free to open an issue or a pull request.🤝 I would be happy to hear your thoughts.

License

📜 This project is licensed under the MIT License.

References

• Go Ecommerce Microservices
• Building A Cat Fact JSON API With MongoDB And Golang