2019-07-22 11:05:16 +02:00
<!-- # 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_RU.md"><img width="20px" src="https://iris - go.com/images/flag - russia.svg?v=10" /></a> <a href="README_ID.md"> <img width="20px" src="https://iris - go.com/images/flag - indonesia.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_PT_BR.md"><img width="20px" src="https://iris - go.com/images/flag - pt - br.svg?v=10" /></a> <a href="README_JPN.md"><img width="20px" src="https://iris - go.com/images/flag - japan.svg?v=10" /></a> -->
2019-10-06 16:46:41 +02:00
# Iris <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_KO.md"><img width="20px" src="https://iris-go.com/images/flag-iran.svg" /></a>
2018-07-24 03:33:53 +02:00
2019-07-22 03:37:04 +02:00
[![build status ](https://img.shields.io/travis/kataras/iris/master.svg?style=for-the-badge )](https://travis-ci.org/kataras/iris) [![report card ](https://img.shields.io/badge/report%20card-a%2B-ff3333.svg?style=for-the-badge )](https://goreportcard.com/report/github.com/kataras/iris)<!--[![godocs](https://img.shields.io/badge/go-%20docs-488AC7.svg?style=for-the-badge)](https://godoc.org/github.com/kataras/iris)--> [![view examples ](https://img.shields.io/badge/learn%20by-examples-0077b3.svg?style=for-the-badge )](https://github.com/kataras/iris/tree/master/_examples) [![chat ](https://img.shields.io/gitter/room/iris_go/community.svg?color=blue&logo=gitter&style=for-the-badge )](https://gitter.im/iris_go/community) [![release ](https://img.shields.io/badge/release%20-v11.2-0077b3.svg?style=for-the-badge )](https://github.com/kataras/iris/releases)
2018-07-24 03:33:53 +02:00
2019-07-22 03:39:14 +02:00
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.
2018-07-24 03:33:53 +02:00
2019-07-22 03:39:14 +02:00
Learn what [others say about Iris ](https://iris-go.com/testimonials/ ) and **star** this github repository.
2018-07-24 03:33:53 +02:00
2019-08-03 07:40:48 +02:00
> Version 11.2 **released!**
[![https://www.facebook.com/iris.framework/posts/3276606095684693 ](https://iris-go.com/images/iris-112-released.png )](https://www.facebook.com/iris.framework/posts/3276606095684693)
2019-07-23 18:34:03 +02:00
2019-07-22 04:46:30 +02:00
## Learning Iris
< details >
2019-07-28 22:20:56 +02:00
< summary > Quick start< / summary >
2019-07-22 04:46:30 +02:00
2018-07-25 05:14:33 +02:00
```sh
2019-06-02 16:49:45 +02:00
# assume the following code in example.go file
2018-07-25 05:14:33 +02:00
$ cat example.go
```
```go
package main
import "github.com/kataras/iris"
func main() {
app := iris.Default()
app.Get("/ping", func(ctx iris.Context) {
ctx.JSON(iris.Map{
"message": "pong",
})
})
2019-07-22 11:05:16 +02:00
2018-07-25 05:14:33 +02:00
app.Run(iris.Addr(":8080"))
}
```
2019-07-22 11:05:16 +02:00
```sh
# run example.go and
# visit http://localhost:8080/ping on browser
2018-07-25 05:14:33 +02:00
$ go run example.go
```
2019-07-22 04:46:30 +02:00
> 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.
2019-07-22 03:39:14 +02:00
2019-07-22 04:46:30 +02:00
### Do you like to read while traveling?
2019-07-22 03:39:14 +02:00
2019-09-01 22:49:09 +02:00
< 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 >
2019-07-30 17:02:02 +02:00
2019-07-22 04:46:30 +02:00
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.
2019-07-22 03:39:14 +02:00
2018-07-24 03:33:53 +02:00
2019-07-22 04:46:30 +02:00
## Contributing
2018-07-24 03:33:53 +02:00
2019-07-22 04:46:30 +02:00
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.
2018-07-24 03:33:53 +02:00
## License
2019-07-22 11:05:16 +02:00
The project name "Iris" was inspired by the Greek mythology.
2019-07-22 04:46:30 +02:00
Iris Web Framework is free and open-source software licensed under the [3-Clause BSD License ](LICENSE ).