UNPKG

5.48 kBMarkdownView Raw
1#### A Microservices API Gateway Built Using Express.js and Express Middleware
2----
3
4[![npm][npm-version-badge]][npm-package-url]
5[![CircleCI][circleci-badge]][circleci-master-url]
6[![AppVeyor][appveyor-badge]][appveyor-master-url]
7[![CodeCov][codecov-badge]][codecov-master-url]
8[![Gitter][gitter-badge]][gitter-room-url]
9[![Module LTS Adopted'](https://img.shields.io/badge/Module%20LTS-Adopted-brightgreen.svg?style=flat)](http://github.com/CloudNativeJS/ModuleLTS)
10
11[![Express-Gateway][eg-wordmark-companion]][eg-website]
12
13Express Gateway is a microservices API gateway that sits at the heart of any microservices or serverless architecture, regardless of what language or platform you're using.
14
15Express Gateway secures your microservices and serverless functions and expose them through APIs using Node.js, Express and Express middleware.
16
17Developing cloud native applications, orchestrating and managing them now can be done insanely fast all on one seamless platform without having to introduce additional infrastructure.
18
19---
20
21### [Website][eg-website]   [Getting Started][eg-getting-started]   [Docs][eg-docs]
22
23---
24#### Main Features
25- Microservices and Serverless QoS Proxy and Security
26- Built Entirely on JavaScript/Node.js using Express and Express Middleware
27- Dynamic Centralized Config
28- API Consumer and Credentials Management
29- Plugins and Plugin Framework
30- Distributed Data Store
31- CLI
32- REST API
33- Cloud Native Execution
34
35#### Installation
36If you have Node.js already installed:
37
38```bash
39# install Express Gateway
40$ npm install -g express-gateway
41```
42
43#### Creating a Gateway
44
45```bash
46# create a new gateway using the CLI
47$ eg gateway create
48```
49
50#### Get Help
51Need help or have a question?
52- [Express Gateway Documentation][eg-docs]
53- [Frequently Asked Questions (FAQ)][eg-faq]
54
55#### Commercial Support
56Express Gateway is commercially supported by [LunchBadger][lb-url]. For more information about support plans please visit [the support page][eg-support].
57
58#### Community
59Express has a large vibrant community that we hope to extend further with Express Gateway's gateway use case for Express and its middleware.
60
61- Come chat with us in [Gitter][gitter-room-url]
62- [Twitter (@express_gateway)][eg-twitter]
63- [Google Group][eg-newsgroup]
64- [Facebook][eg-facebook]
65
66#### Roadmap
67The Express Gateway roadmap consists of three parts:
681. [FeatHub][eg-feathub] - features requested and voted on by any community member, this feeds into the...
692. [Roadmap][eg-roadmap] - the published roadmap of all features under considerations and projected timeframes, the highest priority items are put into the...
703. [Waffle board][eg-waffle] - a real time as a public task board on Waffle.io with backlog of stories for the next release
71
72### LTS Policy
73
74 | Module Version | Release Date | Minimum EOL | EOL With | Status |
75 |------------------|--------------|-------------|--------------|---------|
76 | 1.x.x | Jul 2016 | Dec 2019 | Node 8 | Current |
77
78#### Contribution
79All contributions welcome! Please see the [contributor's guide][contributor-guide]
80
81#### Sponsors
82Express Gateway is proudly sponsored by...
83- [LunchBadger][lb-url] : Makes of Express Serverless Platform - a multi cloud platform to build microservices and serverless cloud native modern apps.
84- [Joyent Triton][joyent-url] : The Next Generation of Cloud - Modern, Hybrid and Open
85
86#### License
87
88[Apache-2.0 License][apache-license]
89
90Copyright © LunchBadger, Inc. and Express Gateway Contributors
91
92[npm-version-badge]: https://img.shields.io/npm/v/express-gateway.svg
93[npm-package-url]: https://www.npmjs.com/package/express-gateway
94[circleci-badge]: https://circleci.com/gh/ExpressGateway/express-gateway/tree/master.svg?style=shield&circle-token=ac6b0e86b46220da43a5ae63a267d12e81ccb2d5
95[circleci-master-url]: https://circleci.com/gh/ExpressGateway/express-gateway/tree/master
96[appveyor-badge]: https://img.shields.io/appveyor/ci/kevinswiber/express-gateway/master.svg
97[appveyor-master-url]: https://ci.appveyor.com/project/kevinswiber/express-gateway
98[codecov-badge]: https://img.shields.io/codecov/c/github/ExpressGateway/express-gateway/master.svg
99[codecov-master-url]: https://codecov.io/gh/ExpressGateway/express-gateway
100[gitter-badge]: https://img.shields.io/gitter/room/expressgateway/express-gateway.svg
101[gitter-room-url]: https://gitter.im/ExpressGateway/express-gateway
102[eg-wordmark-companion]: logo/wordmark-and-companion-graphic/ExpressGateway_Wordmark+Companion.png
103[eg-website]: http://www.express-gateway.io
104[eg-getting-started]: http://www.express-gateway.io/getting-started
105[eg-docs]: http://www.express-gateway.io/docs
106[eg-feathub]: http://feathub.com/ExpressGateway/express-gateway
107[eg-roadmap]: https://github.com/ExpressGateway/express-gateway/wiki/Express-Gateway-Roadmap
108[eg-waffle]: https://waffle.io/ExpressGateway/express-gateway
109[eg-faq]: http://www.express-gateway.io/docs/faq
110[eg-twitter]: https://twitter.com/express_gateway
111[eg-newsgroup]: https://groups.google.com/a/express-gateway.io/forum/#!forum/discuss
112[eg-facebook]: https://www.facebook.com/expressjsgateway
113[eg-support]: https://goo.gl/s8eGKz?_ga=2.243837062.2081566642.1553116846-2009977705.1552945890
114[contributor-guide]: https://github.com/ExpressGateway/express-gateway/blob/master/Contributing.md
115[lb-url]: https://www.lunchbadger.com
116[joyent-url]: https://www.joyent.com
117[apache-license]: https://github.com/expressgateway/express-gateway/blob/master/LICENSE