tree-gateway
This is a full featured and free API Gateway
File Explorer
Download Latest Version (.zip)- hello.js
- README.md
- web-incoming.js
- web-outgoing.js
- ws-incoming.js
- common.js
- index.js
- http-proxy.js
- LICENSE
- README.md
- admin-api.ts
- api.ts
- config-package.ts
- gateway.ts
- health-check.ts
- middleware.ts
- users.ts
- cli-args.ts
- cli-tool.ts
- cli.ts
- errors.ts
- sdk-apis.ts
- sdk-config-package.ts
- sdk-gateway.ts
- sdk-middleware.ts
- sdk-users.ts
- sdk.ts
- utils.ts
- admin.ts
- api.ts
- authentication.ts
- cache.ts
- circuit-breaker.ts
- config-package.ts
- cors.ts
- database.ts
- errors.ts
- events.ts
- filter.ts
- gateway.ts
- group.ts
- jsonata.ts
- logger.ts
- middleware.ts
- protocol.ts
- proxy.ts
- service-discovery.ts
- throttling.ts
- users.ts
- basic.ts
- jwt.ts
- local.ts
- auth.ts
- cache-store.ts
- cache.ts
- client-cache.ts
- redis-store.ts
- server-cache.ts
- circuit-breaker.ts
- express-circuit-breaker.ts
- redis-state-handler.ts
- cors.ts
- json.ts
- mustache.ts
- error-handler.ts
- errors.ts
- ipFilter.ts
- filter.ts
- requestBodyTransformer.ts
- requestHeaders.ts
- requestMustache.ts
- requestXml.ts
- responseBodyTransformer.ts
- responseHeaders.ts
- responseMustache.ts
- responseXml.ts
- webSecurity.ts
- header.ts
- loadBalancer.ts
- query.ts
- trafficSplit.ts
- interceptor.ts
- proxy.ts
- consul.ts
- consul.ts
- service-discovery.ts
- redis.ts
- request.ts
- redis-store.ts
- throttling.ts
- api.ts
- group.ts
- api.ts
- config.ts
- gateway.ts
- middleware.ts
- plugin-data.ts
- users.ts
- api.ts
- config-package.ts
- config.ts
- gateway.ts
- middleware.ts
- plugin-data.ts
- users.ts
- config.ts
- env.ts
- functions.ts
- health-check.ts
- machine.ts
- middleware-installer.ts
- middleware-loader.ts
- path.ts
- time-intervals.ts
- upgrade.ts
- application.ts
- command-line.ts
- configuration.ts
- database.ts
- express-logger.ts
- gateway.ts
- index.ts
- logger.ts
- tree-gateway-default.yaml
- tree-gateway-server-default.yaml
- authenticated.json
- basicAuthentication.json
- basicAuthenticationByGroup.json
- basicAuthenticationByGroupMultiPath.json
- benchmarkHello.json
- cached.json
- circuitbreaker.json
- circuitbreakerTimewindow.json
- cors-middleware.json
- cors.json
- customAuthentication.json
- filtered.json
- headerSplit.yml
- httpbin.json
- intercepted.json
- interceptedByDefaultMiddleware.yml
- invalidServiceDiscoveryConsul.yml
- limitedApi.json
- limitedApiByGroup.json
- loadBalancer.yml
- localAuthentication.json
- postApi.json
- postApiRemoveHeader.json
- querySplit.yml
- serviceDiscoveryConsul.yml
- serviceDiscoveryConsulMiddleware.yml
- simpleApi.json
- trafficSplit.yml
- myJwtStrategy.js
- verifyBasicUser.js
- verifyJwtUser.js
- myOpenHandler.js
- corsOrigin.js
- errorHandler.js
- myCustomFilter.js
- mySecondFilter.js
- changeBodyInterceptor.js
- myRequestInterceptor.js
- mySecondRequestInterceptor.js
- changeBodyResponseInterceptor.js
- myResponseInterceptor.js
- removeHeaderResponseInterceptor.js
- SecondInterceptor.js
- myHandler.js
- myKeyGen.js
- mySkip.js
- server.crt
- server.csr
- server.key
- server.key.org
- consulTestService.ts
- secondConsulTestService.ts
- tree-gateway.json
- admin.spec.ts
- authenticator.spec.ts
- cache.spec.ts
- circuitbreaker.spec.ts
- cors.spec.ts
- install-apis.spec.ts
- proxy.spec.ts
- service-discovery.spec.ts
- tests.spec.ts
- throttling.spec.ts
- uninstall-apis.spec.ts
- mocha.opts
- .dockerignore
- .gitignore
- .npmignore
- .travis.yml
- deploy-docker.sh
- Dockerfile
- ioc.config
- LICENSE.md
- npm-shrinkwrap.json
- package.json
- README.md
- rest.config
- swagger.config.json
- tree-gateway-test.yml
- tree-gateway.json
- tsconfig.json
- tslint.json
# Installation Guide
1. Get the code
git clone https://github.com/TreeGateway/tree-gateway
Downloads the entire project code from GitHub to your computer.
cd tree-gateway
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Node.js Node.js must be installed to use npm.
npm install -g tree-gateway
Installs the package published on the npm registry globally โ no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t tree-gateway .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 tree-gateway
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Node.js
EasyPrerequisites
npm install -g tree-gateway
Installs the package published on the npm registry globally โ no need to clone the source.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)