Giter Club home page Giter Club logo

pulse's Introduction

Go Report Card GitHub license Go Reference Go Doc Discord Online codecov CircleCI

A Golang framework for web development that keeps your web applications and services alive and responsive with its fast and lightweight design.

Features

  • Routing
  • Route groups
  • Static files
  • Simple and elegant API
  • Middleware support

Installation

Make sure you have Go installed on your machine. Then run the following command:

Initialize your project (Learn). Then install Pulse with the go get command:

go get github.com/gopulse/pulse

Getting Started

package main

import (
    "github.com/gopulse/pulse"
)

func main() {
    app := pulse.New()
	router := pulse.NewRouter()

	app.Router = router

	router.Get("/", func(c *pulse.Context) error {
        c.String("Hello, World!")
		return nil
    })

    app.Run(":3000")
}

Examples

  • Routing

Supports GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, CONNECT, TRACE

package main

import (
	"github.com/gopulse/pulse"
)

func main() {
    app := pulse.New()
    router := pulse.NewRouter()
    
    // GET /hello
    router.Get("/", func(c *pulse.Context) error {
        c.String("Hello, World!")
        return nil
    })
    
    // GET /hello/:name
    router.Get("/profile/:id", func(c *pulse.Context) error {
        c.String("Profile: " + c.Param("id"))
        return nil
    })
    
	// GET /user/
    router.Get("/user/*", func(c *pulse.Context) error {
        c.String("Hello, World!")
        return nil
    })
    
    app.Router = router
    
    app.Run(":3000")
}
  • Route groups

Supports GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, CONNECT, TRACE

package main

import (
	"github.com/gopulse/pulse"
)

func main() {
    app := pulse.New()
    router := pulse.NewRouter()
	api := &pulse.Group{
		prefix: "/api",
		router: router,
	}

	v1 := api.Group("/v1")
	v1.GET("/users", func(ctx *Context) error {
		ctx.String("users")
		return nil
	})
    
    app.Router = router
    
    app.Run(":3000")
}
  • Static files
package main

import (
	"github.com/gopulse/pulse"
	"time"
)

func main() {
	app := pulse.New()
	router := pulse.NewRouter()

	// Static files (./static) with cache duration 24 hours
	router.Static("/", "./static", &pulse.Static{
		Compress:      true,
		ByteRange:     false,
		IndexName:     "index.html",
		CacheDuration: 24 * time.Hour,
	})

	app.Router = router

	app.Run(":3000")
}
  • Middleware
package main

import (
	"github.com/gopulse/pulse"
)

func main() {
	app := pulse.New()
	router := pulse.NewRouter()
	
	router.Get("/profile/:name", func(ctx *pulse.Context) error {
		if ctx.Param("name") != "test" {
			ctx.Abort()
			ctx.Status(404)
			return nil
		}
		ctx.String("hello")
		ctx.Next()
		return nil
	})

	app.Router = router

	app.Run(":3000")
}

Available Middleware

  • CORS Middleware: Enable cross-origin resource sharing (CORS) with various options.
package main

import (
	"github.com/gopulse/pulse"
)

func main() {
	app := pulse.New()
	router := pulse.NewRouter()

	router.Get("/", func(ctx *pulse.Context) error {
		return nil
	})

	router.Use("GET", pulse.CORSMiddleware())

	app.Router = router

	app.Run(":3000")
}
  • Logger Middleware: Log every request with configurable options. (Coming soon)
  • Encrypt Cookie Middleware: Encrypt and decrypt cookie values. (Coming soon)
  • Timeout Middleware: Set a timeout for requests. (Coming soon)

License

Pulse is licensed under the MIT License. See LICENSE for the full license text.

Contributing

Contributions are welcome! Please read the contribution guidelines first.

Support

If you want to say thank you and/or support the active development of Pulse:

  1. Add a GitHub Star to the project.
  2. Tweet about the project on your Twitter
  3. Write a review or tutorial on Medium, dev.to, Reddit or personal blog.
  4. Buy Me a Coffee

Contributors

Stargarazers over time

Stargazers over time

pulse's People

Contributors

2hmad 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.