Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gopulse/pulse
Pulse: A Golang framework for web development
https://github.com/gopulse/pulse
go golang golang-framework gopulse web
Last synced: 2 months ago
JSON representation
Pulse: A Golang framework for web development
- Host: GitHub
- URL: https://github.com/gopulse/pulse
- Owner: gopulse
- License: mit
- Created: 2023-03-31T00:49:48.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-26T22:51:17.000Z (over 1 year ago)
- Last Synced: 2024-06-19T09:41:45.877Z (7 months ago)
- Topics: go, golang, golang-framework, gopulse, web
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 37
- Watchers: 0
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/gopulse/pulse)
[](LICENSE)
[](https://pkg.go.dev/github.com/gopulse/pulse)
[](https://pkg.go.dev/github.com/gopulse/pulse#pkg-overview)
[](https://discord.gg/JKcTwZYJ)
[](https://codecov.io/gh/gopulse/pulse)
[](https://dl.circleci.com/status-badge/redirect/gh/gopulse/pulse/tree/master)
A **Golang** framework for web development that keeps your web applications and services 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](https://go.dev/blog/using-go-modules)). Then install **Pulse** with the go get command:
```bash
go get github.com/gopulse/pulse
```
## Benchmarks :zap:
This test was performed by [Go Web](https://github.com/smallnest/go-web-framework-benchmark).
## Getting Started
```go
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`
```go
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`
```go
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
```go
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
```go
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
- [x] CORS Middleware: Enable cross-origin resource sharing (CORS) with various options.
```go
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](LICENSE) for the full license text.
## Contributing
Contributions are welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
## Support
If you want to say thank you and/or support the active development of Pulse:
1. Add a [GitHub Star](https://github.com/gopulse/pulse/stargazers) to the project.
2. Tweet about the project [on your Twitter](https://twitter.com/intent/tweet?text=Pulse%20is%20a%20%23web%20%23framework%20for%20the%20%23Go%20programming%20language.%20It%20is%20a%20lightweight%20framework%20that%20is%20%23easy%20to%20use%20and%20easy%20to%20learn.%20It%20is%20designed%20to%20be%20a%20simple%20and%20elegant%20solution%20for%20building%20web%20applications%20and%20%23APIs%20%F0%9F%9A%80%20https%3A%2F%2Fgithub.com%2Fgopulse%2Fpulse)
3. Write a review or tutorial on [Medium](https://medium.com/), [dev.to](https://dev.to/), [Reddit](https://www.reddit.com/) or personal blog.
4. [Buy Me a Coffee](https://www.buymeacoffee.com/gopulse)
## Contributors
## Stargarazers over time
[](https://starchart.cc/gopulse/pulse)