akangaziz/iris

The fastest web framework for Go in (THIS) Earth.

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.6

$ 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

• Post an issue or idea here.
• Chat.

Iris takes very seriously your opinion,

• Contribute: New website and logo for Iris

Features

• Focus on high performance
• Robust routing, static, wildcard subdomains and routes.
• Websocket API, Sessions support out of the box
• 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

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.

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.0.0-alpha.4

Iris is an active project

Todo

for 'v4'

• Refactor & extend view engine, separate the engines from the main code base, easier for the community to create new view engines*
• Refactor & extend sessions, split the different databases functionality to the iris-contrib*
• Refactor & extends the rest render engine in order to be able to developer to use their own implemention for rendering restful types, like, for example a custom JSON implementation using no-standard go package for encode/decode*
• Move the iris/websocket package's source code inside iris/websocket.go one file, to be easier to use by users without import a new package*
• Implement all opened community's feature requests
• Extend i18n middleware for easier and better internalization support
• Create a router as optional plugin, for optional path parts. Its name, 'ryan', taken from the community-member and donator who requested this feature
• Extend the iris control plugin
• Remove deprecated functions

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.