Giter Club home page Giter Club logo

go-platform-detection's Introduction

Go Platform Detection

License: MIT

This Go package provides a robust device detection mechanism based on User-Agent headers. It is designed to help web applications distinguish between normal browsers, mobile devices, and tablets.

Features

  • Detects devices based on User-Agent headers.
  • Compatible with the Gin web framework.
  • Provides an easy-to-use middleware for integrating device detection into your Gin application.
  • Supports identification of normal browsers, mobile devices, and tablets.

Installation

Install the package using go get:

go get github.com/uzzalhcse/go-platform-detection

Usage

  1. Import the package:
import "github.com/uzzalhcse/go-platform-detection"
  1. Add the middleware to your Gin router:

    r := gin.Default()
    r.Use(platform.ResolveDevice())
    
  2. Retrieve the detected device type in your handlers:

    device := platform.GetDevice(c)
    

Example

package main

import (
"github.com/gin-gonic/gin"
"github.com/uzzalhcse/go-platform-detection"
)

func main() {
r := gin.Default()

	// Use the platform detection middleware
	r.Use(platform.ResolveDevice())

	r.GET("/hello", func(c *gin.Context) {
		device := platform.GetDevice(c)
		c.JSON(200, gin.H{
			"message":   "Hello World!",
			"device":    device,
			"platform":  device.GetPlatform(),
			"is_normal": device.IsNormal(),
			"is_mobile": device.IsMobile(),
			"is_tablet": device.IsTablet(),
		})
	})

	r.Run()
}

Contributing

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Uzzal Hosen

go-platform-detection's People

Contributors

uzzalhcse avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.