Giter VIP home page Giter VIP logo

thesmartmonkey / sls-multi-offline Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 42.2 MB

Run multiple serverless api or db instance under 1 URL for local development purposes

Home Page: https://www.npmjs.com/package/sls-multi-offline

License: MIT License

TypeScript 73.33% JavaScript 26.67%
serverless serverless-framework serverless-offline serverless-dynamodb-local-plugin serverless-offline-plugin

sls-multi-offline's Introduction

sls-multi-offline

Run multiple serverless api or db instance under 1 URL for local development purposes

This repo is inspired from 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

Getting started

Installation

sls-multi-offline needs to be installed globally using the following command:

npm install -g sls-multi-offline

Config

After installing sls-multi-offline, cd into your project directory

cd [project-directory]

Create a offline config file

touch offline.yml

Inside your sls-multi-offline config file add the services you would like to run

port: [port the proxy will run on - (optional: default is 3100)]
stage: [stage the proxy will run on - (optional: default is dev)]
services:
  - name: [name of the service]
    path: [proxy path to the service]
    source: [path to the serverless.yml file belong to that service]
    type: [api or db]
  - name: [name of the service 2]
    path: [proxy path to the service 2]
    source: [path to the serverless.yml file belong to that service]
    type: [api or db]

Exemple :

port: 3100
services:
  - name: posts
    path: posts
    source: ./sample/posts
    type: api
  - name: users
    path: users
    source: ./sample/users
    type: api
  - name: db
    path: db
    source: ./sample/db
    type: db

All paths by default are mapped to localhost:[port]/[path].

Usage

To run sls-multi-offline, execute the following cmd in the directory with the config file

sls-multi-offline

For contributors

Debug :

npm run dev

create a post :

curl -X POST -H "Content-Type:application/json" http://localhost:3100/dev/create-post --data '{ "text": "Learn Serverless" }'

create a user :

curl -X POST -H "Content-Type:application/json" http://localhost:3101/dev/create-user --data '{ "text": "Learn Serverless" }'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.