https://github.com/edis/sls-multi-gateways
Run multiple serverless functions under one URL 🔗
https://github.com/edis/sls-multi-gateways
api-gateway serverless typescript
Last synced: 8 months ago
JSON representation
Run multiple serverless functions under one URL 🔗
- Host: GitHub
- URL: https://github.com/edis/sls-multi-gateways
- Owner: edis
- License: mit
- Created: 2021-05-25T22:03:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-09T01:07:09.000Z (over 4 years ago)
- Last Synced: 2023-02-26T19:44:20.662Z (about 3 years ago)
- Topics: api-gateway, serverless, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/sls-multi-gateways
- Size: 135 KB
- Stars: 5
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sls-multi-gateways
sls-multi-gateways is a tool that allows you to run multiple api gateways under one domain for local development purposes.
[Here is a walkthrough article on medium](https://medium.com/@edisgonuler/run-multiple-serverless-applications-d8b38ef04f37)
## Installation
sls-multi-gateways needs to be installed globally using the following command:
```bash
npm install -g sls-multi-gateways
```
## Usage
After installing sls-multi-gateways, cd into your project directory
```bash
cd [project-directory]
```
Create a sls-multi-gateways config file
```bash
touch sls-multi-gateways.yml
```
Inside your sls-multi-gateways config file add the services you would like to run
```bash
port: [port the proxy will run on - (optional: default is 3000)]
stage: [stage the proxy will run on - (optional: default is dev)]
services:
- srvName: [name of the service]
srvPath: [proxy path to the service]
srvSource: [path to the serverless.yml file belong to that service]
stripBasePath: [whether the srvPath will be passed on to the proxy]
- srvName: [name of the service 2]
srvPath: [proxy path to the service 2]
srvSource: [path to the serverless.yml file belong to that service]
stripBasePath: [whether the srvPath will be passed on to the proxy]
```
All srvPaths by default are mapped to ```localhost:[port]/[srvPath]```. To remove ```srvPath``` , set ```stripBasePath``` to ```true```.
To run sls-multi-gateways, execute the following cmd in the directory with the config file
```bash
sls-multi-gateways
```