go-packages/iris
1
0
Fork 0
mirror of https://github.com/kataras/iris.git synced 2025-01-23 10:41:03 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
716b5001da
iris/README.md
Gerasimos Maropoulos 716b5001da Fix https://github.com/iris-contrib/middleware/issues/13
2016-09-30 18:48:48 +03:00

7.0 KiB
Raw Blame History

iris: sometimes the simplicity is the best solution

Travis Widget Report Widget Awesome Widget License Widget Release Widget Examples Widget Documentation Widget Chat Widget
Iris Logo

The fastest web framework for Go. Easy to learn, while it's highly customizable. Ideally suited for both experienced and novice Developers.

Features

  • Focus on high performance
  • Automatically install TLS certificates from https://letsencrypt.org
  • Proxy HTTP and WebSocket requests
  • Robust routing and middleware ecosystem
  • Define virtual hosts and (wildcard) subdomains with path level routing
  • Graceful shutdown
  • Limit request body
  • I18N
  • Serve static files
  • Log requests
  • Gzip response
  • Authentication
  • OAuth, OAuth2 supporting 27+ popular websites
  • JWT
  • Basic Authentication
  • HTTP Sessions
  • Add / Remove trailing slash from the URL with option to redirect
  • Redirect requests
  • HTTP to HTTPS
  • HTTP to HTTPS WWW
  • HTTP to HTTPS non WWW
  • Non WWW to WWW
  • WWW to non WWW
  • View system supporting more than six template engines
  • Highly scalable rich render (Markdown, JSON, JSONP, XML...)
  • Websocket API similar to socket.io
  • Hot Reload
  • Typescript integration + Web IDE
  • Checks for updates at startup

Getting Started

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.

Need help?

FAQ

Explore these questions or navigate to the community chat.

Support

Hi, my name is Gerasimos Maropoulos and I'm the author of this project, let me put a few words about me.

I started to design iris the night of the 13 March 2016, some weeks later, iris started to became famous and I have to fix many issues and implement new features, but I didn't have time to work on Iris because I had a part time job and the (software engineering) colleague which I studied.

I wanted to make iris' users proud of the framework they're using, so I decided to interupt my studies and colleague, two days later I left from my part time job also.

Today I spend all my days and nights coding for Iris, and I'm happy about this, therefore I have zero incoming value.

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. Keep note that, today, iris has the clostest performance to the nginx.

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 test aims to compare the whole HTTP request processing between Go web frameworks.

Benchmark Wizzard July 21, 2016- Processing Time Horizontal Graph

The results have been updated on July 21, 2016

Testing

I recommend writing your API tests using this new library, httpexpect which supports Iris and fasthttp now, after my request here. You can find Iris examples here, here and here.

Versioning

Current: v4.4.2

Iris is an active project

Read more about Semantic Versioning 2.0.0

Contributing

If you are interested in contributing to the Iris project, please make sure that you read the document CONTRIBUTING first.

  • Report issues
  • Suggest new features or enhancements

People

The big thanks goes to all people who help building this framework with feature-requests & bug reports!

The author of Iris is @kataras. If you're willing to donate, feel free to navigate to the DONATIONS PAGE.

License

This project is licensed under the MIT License, Copyright (c) 2016 Gerasimos Maropoulos.