mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 18:51:03 +01:00
88 lines
4.5 KiB
Markdown
88 lines
4.5 KiB
Markdown
<!-- <div align="center"> -->
|
|
<!-- <a href="https://iris-go.com"><img src="https://iris-go.com/images/logo-sm.png" alt="iris-go.com logo" height="160"></a> -->
|
|
|
|
<!-- [](https://github.com/kataras/iris/stargazers) -->
|
|
|
|
# Iris Web Framework <a href="README_ZH.md"><img width="20px" src="https://iris-go.com/images/flag-china.svg?v=10" /></a> <a href="README_GR.md"><img width="20px" src="https://iris-go.com/images/flag-greece.svg?v=10" /></a> <a href="README_ES.md"><img width="20px" src="https://iris-go.com/images/flag-spain.png" /></a> <a href="README_KO.md"><img width="20px" src="https://iris-go.com/images/flag-south-korea.svg" /></a> <a href="README_FA.md"><img width="20px" src="https://iris-go.com/images/flag-iran.svg" /></a>
|
|
|
|
<!-- </div> -->
|
|
|
|
[](https://travis-ci.org/kataras/iris) [](https://goreportcard.com/report/github.com/kataras/iris)<!--[](https://godoc.org/github.com/kataras/iris)--> [](https://github.com/kataras/iris/tree/master/_examples) [](https://gitter.im/iris_go/community) [](https://www.paypal.me/kataras) <!-- [](https://github.com/kataras/iris/releases) -->
|
|
|
|
Iris is a fast, simple yet fully featured and very efficient web framework for Go. It provides a beautifully expressive and easy to use foundation for your next website or API.
|
|
|
|
Learn what [others saying about Iris](https://iris-go.com/testimonials/) and **[star](https://github.com/kataras/iris/stargazers)** this open-source project to support its potentials.
|
|
|
|
[](https://iris-go.com/testimonials/)
|
|
|
|
## Learning Iris
|
|
|
|
<details>
|
|
<summary>Quick start</summary>
|
|
|
|
```sh
|
|
# assume the following code in example.go file
|
|
$ cat example.go
|
|
```
|
|
|
|
```go
|
|
package main
|
|
|
|
import "github.com/kataras/iris/v12"
|
|
|
|
func main() {
|
|
app := iris.Default()
|
|
app.Get("/ping", func(ctx iris.Context) {
|
|
ctx.JSON(iris.Map{
|
|
"message": "pong",
|
|
})
|
|
})
|
|
|
|
app.Run(iris.Addr(":8080"))
|
|
}
|
|
```
|
|
|
|
```sh
|
|
# run example.go and
|
|
# visit http://localhost:8080/ping on browser
|
|
$ go run example.go
|
|
```
|
|
|
|
> Routing is powered by [muxie](https://github.com/kataras/muxie), the most powerful and fastest trie-based software written in Go.
|
|
|
|
</details>
|
|
|
|
Iris contains extensive and thorough **[wiki](https://github.com/kataras/iris/wiki)** making it easy to get started with the framework.
|
|
|
|
|
|
|
|
For a more detailed technical documentation you can head over to our [godocs](https://godoc.org/github.com/kataras/iris). And for executable code you can always visit the [_examples](_examples/) repository's subdirectory.
|
|
|
|
### Do you like to read while traveling?
|
|
|
|
<a href="https://bit.ly/iris-req-book"> <img alt="Book cover" src="https://iris-go.com/images/iris-book-cover-sm.jpg" width="200" /> </a>
|
|
|
|
<!-- [](https://twitter.com/intent/follow?screen_name=makismaropoulos) -->
|
|
|
|
You can [request](https://bit.ly/iris-req-book) a PDF version and online access of the **E-Book** today and be participated in the development of Iris.
|
|
|
|
## Contributing
|
|
|
|
We'd love to see your contribution to the Iris Web Framework! For more information about contributing to the Iris project please check the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
|
|
|
[List of all Contributors](https://github.com/kataras/iris/graphs/contributors)
|
|
|
|
## Security Vulnerabilities
|
|
|
|
If you discover a security vulnerability within Iris, please send an e-mail to [iris-go@outlook.com](mailto:iris-go@outlook.com). All security vulnerabilities will be promptly addressed.
|
|
|
|
## License
|
|
|
|
The project name "Iris" was inspired by the Greek mythology.
|
|
|
|
Iris Web Framework is free and open-source software licensed under the [3-Clause BSD License](LICENSE).
|
|
|
|
## Stargazers over time
|
|
|
|
[](https://starchart.cc/kataras/iris)
|