Skip to content
Escapin the Transpiler for Escaping from Complicated Usage of Cloud Services and APIs
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
src
templates
test
.eslintrc.js
.gitignore
.prettierrc.js
.travis.yml
LICENSE
README.md
ava.config.js
nyc.config.js
package.json
tsconfig.json
yarn.lock

README.md

Escapin

the Transpiler for Escaping from Complicated Usage of Cloud Services and APIs

npm version Build Status dependencies Status devDependencies Status codecov Maintainability MIT License

Prerequisites

  1. Node.js
  2. Yarn
  3. Serverless Framework
yarn global add serverless
  1. The install location is added to your PATH
export PATH="$(yarn global bin):$PATH"

Installation

yarn global add escapin

or

npm install -g escapin

Using Yarn is preferred because Escapin internally uses Yarn to install TypeScript type declarations (@types) for your project.

Usage

Escapin provides CLI escapin that works on Node.js project directories containing ./package.json.

First, run escapin on the project folder:

cd examples/sendmail

escapin

Escapin transpiles your source code into executable one as a serverless application, and generates serverless.yml that can be used for deploying the programs to cloud services by Serverless Framework.

Then, run serverless deploy on ./build folder containing Escapin artifacts:

cd build

serverless deploy

CLI options

  -V, --version         output the version number
  -d, --dir <dir>       working directory (default: ".")
  --ignore-path <path>  specify path of ignore file (default: ".gitignore")
  -h, --help            output usage information

Documentation

Users Guide

You can’t perform that action at this time.