mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 18:51:03 +01:00
c935e5d7d1
Former-commit-id: 778fedba71bc146709e840c7a37545e516c7a287
77 lines
4.3 KiB
Markdown
77 lines
4.3 KiB
Markdown
<!-- # 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> -->
|
|
|
|
# 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_FA.md"><img width="20px" src="https://iris-go.com/images/flag-iran.svg" /></a>
|
|
|
|
[![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-v12.0-0077b3.svg?style=for-the-badge)](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 say about Iris](https://iris-go.com/testimonials/) and **star** this github repository.
|
|
|
|
|
|
Iris **version 12 released**. Read more [here](HISTORY.md#sa-26-october-2019--v1200).
|
|
|
|
## 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-request-book"> <img alt="Book cover" src="https://iris-go.com/images/iris-book-cover-sm.jpg" width="200" /> </a>
|
|
|
|
You can [request](https://bit.ly/iris-request-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).
|