github.hscsec.cn/aerogo/aero@v1.0.0/README.md (about)

     1  ![Aero Go Logo](docs/images/aero.go.png)
     2  
     3  [![Godoc reference][godoc-image]][godoc-url]
     4  [![Go report card][goreportcard-image]][goreportcard-url]
     5  [![Tests][travis-image]][travis-url]
     6  [![Code coverage][codecov-image]][codecov-url]
     7  [![License][license-image]][license-url]
     8  
     9  Aero is a high-performance web server with a clean API for web development.
    10  
    11  ## Installation
    12  
    13  ```bash
    14  go get github.com/aerogo/aero/...
    15  ```
    16  
    17  ## Usage
    18  
    19  ![Aero usage](docs/usage.gif)
    20  
    21  Run this in an empty directory:
    22  
    23  ```bash
    24  aero -newapp
    25  ```
    26  
    27  Now you can build your app with `go build` or use the more advanced [run](https://github.com/aerogo/run) tool.
    28  
    29  ## Features
    30  
    31  - Makes it easy to reach top scores in [Lighthouse](https://developers.google.com/web/tools/lighthouse/), [PageSpeed](https://developers.google.com/speed/pagespeed/insights/) and [Mozilla Observatory](https://observatory.mozilla.org/)
    32  - Optimized for high latency environments (mobile networks)
    33  - Has a strict content security policy
    34  - Calculates E-Tags out of the box
    35  - Finishes ongoing requests on a server shutdown
    36  - Supports HTTP/2, IPv6 and Web Manifest
    37  - Automatic HTTP/2 push of configured resources
    38  - Supports session data with custom stores
    39  - Allows pushing live data to the client via SSE
    40  - Provides http and https listener
    41  - Shows response time and size for your routes
    42  - Can run standalone without `nginx` babysitting it
    43  
    44  ## Optional
    45  
    46  - [layout](https://github.com/aerogo/layout) as a layout system
    47  - [pack](https://github.com/aerogo/pack) to compile Pixy, Scarlet and JS assets in record time
    48  - [run](https://github.com/aerogo/run) which automatically restarts your server on code/template/style changes
    49  - [pixy](https://github.com/aerogo/pixy) as a high-performance template engine similar to Jade/Pug
    50  - [scarlet](https://github.com/aerogo/scarlet) as an aggressively compressing stylesheet preprocessor
    51  - [nano](https://github.com/aerogo/nano) as a fast, decentralized and git-trackable database
    52  - [api](https://github.com/aerogo/api) to automatically implement your REST API routes
    53  - [markdown](https://github.com/aerogo/markdown) as an overly simplified markdown wrapper
    54  - [http](https://github.com/aerogo/http) as an HTTP client with a simple and clean API
    55  - [log](https://github.com/aerogo/log) for simple & performant logging
    56  
    57  ## Documentation
    58  
    59  - [API](docs/API.md)
    60  - [Configuration](docs/Configuration.md)
    61  - [Benchmarks](docs/Benchmarks.md)
    62  
    63  ## Others
    64  
    65  - [Slides for OWDDM talk](https://docs.google.com/presentation/d/166I69goLEVuvuFeeRfUu8c5lwl2_HAeSi2SZyzIuEKg/edit) (Osaka, May 2018)
    66  - [Discord community][discord-url]
    67  - [Twitter account](https://twitter.com/aeroframework)
    68  - [Facebook page](https://www.facebook.com/aeroframework/)
    69  
    70  ## Author
    71  
    72  | [![Eduard Urbach on Twitter](https://gravatar.com/avatar/16ed4d41a5f244d1b10de1b791657989?s=70)](https://twitter.com/eduardurbach "Follow @eduardurbach on Twitter") |
    73  |---|
    74  | [Eduard Urbach](https://eduardurbach.com) |
    75  
    76  [godoc-image]: https://godoc.org/github.com/aerogo/aero?status.svg
    77  [godoc-url]: https://godoc.org/github.com/aerogo/aero
    78  [goreportcard-image]: https://goreportcard.com/badge/github.com/aerogo/aero
    79  [goreportcard-url]: https://goreportcard.com/report/github.com/aerogo/aero
    80  [travis-image]: https://travis-ci.org/aerogo/aero.svg?branch=master
    81  [travis-url]: https://travis-ci.org/aerogo/aero
    82  [codecov-image]: https://codecov.io/gh/aerogo/aero/branch/master/graph/badge.svg
    83  [codecov-url]: https://codecov.io/gh/aerogo/aero
    84  [sourcegraph-image]: https://sourcegraph.com/github.com/aerogo/aero/-/badge.svg
    85  [sourcegraph-url]: https://sourcegraph.com/github.com/aerogo/aero?badge
    86  [license-image]: https://img.shields.io/badge/license-MIT-blue.svg
    87  [license-url]: https://github.com/aerogo/aero/blob/master/LICENSE
    88  [discord-image]: https://img.shields.io/badge/discord-aero-738bd7.svg
    89  [discord-url]: https://discord.gg/vyk2MnK