| config | ||
| context | ||
| iris | ||
| utils | ||
| .gitignore | ||
| .travis.yml | ||
| context_test.go | ||
| context.go | ||
| CONTRIBUTING.md | ||
| DONATIONS.md | ||
| HISTORY.md | ||
| http_test.go | ||
| http.go | ||
| iris_test.go | ||
| iris.go | ||
| LICENSE | ||
| plugin_test.go | ||
| plugin.go | ||
| README.md | ||
| response.go | ||
| ssh.go | ||
| template.go | ||
| websocket.go | ||
The fastest backend web framework, written entirely in Go.
Easy to learn, while it's highly customizable.
Ideally suited for both experienced and novice Developers.
Installation
The only requirement is the Go Programming Language, at least v1.7
$ go get -u github.com/kataras/iris/iris
If you have installation issues or you are connected to the Internet through China please, click here.
Docs & Community
-
The most important is to read the practical guide.
-
Explore & download the examples.
-
HISTORY.md file is your best friend.
If you'd like to discuss this package, or ask questions about it, feel free to
New website-docs & logo have been designed by the community*
- Website created by @kujtimiihoxha
- Logo designed by @OneebMalik
Features
- Focus on high performance
- Robust routing, static, wildcard subdomains and routes.
- Websocket API, Sessions support out of the box
- Remote control through SSH
- View system supporting 6+ template engines
- Highly scalable response engines
- Live reload
- Typescript integration + Online editor
- OAuth, OAuth2 supporting 27+ API providers, JWT, BasicAuth
- and many other surprises
| Name | Description | Usage |
|---|---|---|
| JSON | JSON Response Engine (Default) | example 1,example 2, book section |
| JSONP | JSONP Response Engine (Default) | example 1,example 2, book section |
| XML | XML Response Engine (Default) | example 1,example 2, book section |
| Markdown | Markdown Response Engine (Default) | example 1,example 2, book section |
| Text | Text Response Engine (Default) | example 1, book section |
| Binary Data | Binary Data Response Engine (Default) | example 1, book section |
| HTML/Default Engine | HTML Template Engine (Default) | example , book section |
| Django Engine | Django Template Engine | example , book section |
| Pug/Jade Engine | Pug Template Engine | example , book section |
| Handlebars Engine | Handlebars Template Engine | example , book section |
| Amber Engine | Amber Template Engine | example , book section |
| Markdown Engine | Markdown Template Engine | example , book section |
| Basicauth Middleware | HTTP Basic authentication | example 1, example 2, book section |
| JWT Middleware | JSON Web Tokens | example , book section |
| Cors Middleware | Cross Origin Resource Sharing W3 specification | how to use |
| Secure Middleware | Facilitates some quick security wins | example |
| I18n Middleware | Simple internationalization | example, book section |
| Recovery Middleware | Safety recover the station from panic | example |
| Logger Middleware | Logs every request | example, book section |
| Editor Plugin | Alm-tools, a typescript online IDE/Editor | book section |
| Typescript Plugin | Auto-compile client-side typescript files | book section |
| OAuth,OAuth2 Plugin | User Authentication was never be easier, supports >27 providers | example, book section |
| Iris control Plugin | Basic (browser-based) control over your Iris station | example, book section |
go-* packages
| Name | Description |
|---|---|
| go-template | Cross-framework template engines |
| go-websocket | A websocket server and ,optionally, client side lib for Go |
| go-sessions | The fastest (web) session manager for the Go Programming Language. |
| go-template | Serialize any custom type to []byte or string. Your custom serializers are finally, organised. |
| go-errors | Error handling |
| go-fs | File system utils, including gzip writer and common net/http static files handlers |
| go-events | Nodejs-style EventEmmiter for Go |
| go-mailer | E-mail Sender, send rich mails with one call |
| rizla | Monitor and live-reload of your Go App |
| Q | HTTP2 Web Framework, 100% compatible with net/http |
FAQ
Explore these questions or navigate to the community chat.
Philosophy
The Iris philosophy is to provide robust tooling for HTTP, making it a great solution for single page applications, web sites, hybrids, or public HTTP APIs.
Iris does not force you to use any specific ORM or template engine. With support for the most used template engines, you can quickly craft the perfect application.
Iris is built on top of fasthttp (http basic layer), net/http middleware will not work by default on Iris, but you can convert any net/http middleware to Iris, see middleware repository to see how.
If for any personal reasons you think that Iris+fasthttp is not suitable for you, but you don't want to miss the unique features that Iris provides, you can take a look at the Q web framework.
Benchmarks
This Benchmark suite aims to compare the whole HTTP request processing between Go web frameworks.
The results have been updated on July 21, 2016
Please click here to view all detailed benchmarks.
Testing
Community should write third-party or iris base tests to the iris-contrib/tests repository. I recommend writing your API tests using this new library, httpexpect which supports Iris and fasthttp now, after my request here.
Versioning
Current: v4.1.5
Iris is an active project
Todo
Iris is a community-driven project, waiting for your suggestions and feature requests to add some items here!
If you're willing to donate click here!
People
The big thanks goes to all people who help building this framework with feature-requests & bug reports!
The author of Iris is @kataras.
Contributing
If you are interested in contributing to the Iris project, please see the document CONTRIBUTING.
License
This project is licensed under the MIT License.
License can be found here.