# squeezer-metabaron

> Event-driven APIs & Web apps on microservices, serverless ! Squeezer is a framework designed to help developers to get a better architecture on serverless zero-administration compute platforms with code that runs into [microservices](https://en.wikipedia.

Latest version **1.1.14** (published 2017-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install squeezer-metabaron
pnpm add squeezer-metabaron
yarn add squeezer-metabaron
bun add squeezer-metabaron
```

Provides the commands `sqz`, `squeezer`, `squeezer-cli`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.14 |
| Published | 2017-09-14 |
| First published | 2017-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3294 |
| Maintainers | fernandoespinosa |
| Keywords | squeezer.io, squeezer.io framework, squeezer framework, squeezer, squeezer cli, squeezer generator, serverless, serverless framework, microservices, micro, service, microservices, aws lambda, lambda, API, web, web app, swagger, swagger api docs, pug, reactjs, jade, aws, amazon web services lambda, api gateway, cloudfront, azure functions, google cloud functions, ibm openwhisk, iot, internet of things |

## Links

- npm: https://www.npmjs.com/package/squeezer-metabaron
- Repository: https://github.com/SqueezerIO/squeezer
- Homepage: https://squeezer-metabaron.com
- Issues: https://github.com/SqueezerIO/squeezer/issues
- npm.io page: https://npm.io/package/squeezer-metabaron

## Dependencies (14)

- [colors](https://npm.io/package/colors.md) ^1.1.2
- [lodash](https://npm.io/package/lodash.md) ^4.15.0
- [moment](https://npm.io/package/moment.md) ^2.17.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.6.1
- [request](https://npm.io/package/request.md) ^2.81.0
- [archiver](https://npm.io/package/archiver.md) ^1.1.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.6
- [fs-extra](https://npm.io/package/fs-extra.md) ^2.0.0
- [sync-exec](https://npm.io/package/sync-exec.md) ^0.6.2
- [walk-sync](https://npm.io/package/walk-sync.md) ^0.3.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.15.2
- [home-config](https://npm.io/package/home-config.md) ^0.1.0
- [templatestring](https://npm.io/package/templatestring.md) ^5.0.1
- [update-notifier](https://npm.io/package/update-notifier.md) ^1.0.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.14 (latest) — 2017-09-14

## README

![Squeezer Intro](docs/gitbook/images/introduction.png)

## [Watch video](https://www.youtube.com/watch?v=DfRnJOZvtJg&t=3s)

### Framework : [squeezer.io](https://squeezer.io)
### Docs : [docs.squeezer.io](https://docs.squeezer.io)
### Chat : [chat.squeezer.io](http://chat.squeezer.io)

[![Squeezer.IO](docs/gitbook/images/badge.svg)](https://Squeezer.IO)
[![Build Status](https://travis-ci.org/SqueezerIO/squeezer.svg?branch=master)](https://travis-ci.org/SqueezerIO/squeezer)
[![npm version](https://badge.fury.io/js/squeezer-cli.svg)](https://badge.fury.io/js/squeezer-cli)
[![Join the chat at https://gitter.im/SqueezerIO/squeezer](https://badges.gitter.im/SqueezerIO/squeezer.svg)](https://gitter.im/SqueezerIO/squeezer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![DUB](https://img.shields.io/dub/l/vibe-d.svg)]()

![Quick Getting Started](docs/gitbook/images/getting-started-tutorial-quick.gif)

## Contents

* [Getting Started](#getting-started)
* [Example Projects](#example-projects)
* [Features](#features)
* [Templates](#templates)
* [Plugins](#plugins)
* [Example Projects](#example-projects)
* [Contributing](#contributing)
* [Community](#community)

## What is Squeezer ?

Squeezer is a framework designed to help  developers to get a better architecture on serverless
zero-administration compute platforms where code runs on the top of
[microservices](https://en.wikipedia.org/wiki/Microservices) clouds like
[AWS Lambda](https://aws.amazon.com/documentation/lambda/) , [Azure Functions](https://azure.microsoft.com/en-us/services/functions/) , [IBM OpenWhisk](https://developer.ibm.com/openwhisk/) & [Google Functions](https://cloud.google.com/functions/)

## <a name="features"></a>Features in short

- [Swagger UI](http://swagger.io/) API REST  documentation support
- **SEO-friendly** web apps with the [PUG](https://pugjs.org/) support ( formerly known as **JADE** ) + your favorite JS framework + CDN integrated support for project's assets (js, images, css, ...)
- share components between microservices
- auto-deployable, auto-scalable , no DevOps requirements
- silent deployments ,no interruption for the current functionality ( really useful on production )
- access deployed resources credentials (DB user, pass ...) directly from `process.env` variables  
- one single command to simultaneously deploy all available microservices on your project
- quick intuitive code deployments by using a special mechanism which will deploy only assets, functions and file packages
where code changed from the last deployment
- automatic rollback to the previous working deployment if something goes wrong
- sequential deployments, wait for the current deployments in progress to finish
- self-healing microservices
- test your code locally on a simulated microservices platform for a faster development cycle
- separate your environments in multiple stages
- extend framework functionality with your own "home-made" plugins
- pay only for the usage ( no monthly subscriptions )
- competitive pricing (  >= 2$ / 1 million HTTP requests )
- smart external dependencies inclusion into the compiled microservice ( **node_modules** and other project files ) ... just
like on any other trivial NodeJS project
- Babel ES6/ES7 + Webpack 2 integration

### Requirements

- [Install node.js](http://nodejs.org/) version `>=6`

## Squeezer CLI

> Squeezer command-line interface

### <a name="templates"></a>Templates

Create a quick project stub by using templates :

| template | description |
|-----|--------------|
|aws-api-nodejs | AWS generic API app template. |
|aws-web-nodejs | AWS generic WEB app template. |
|azure-api-nodejs | Azure generic API app template. |
|azure-web-nodejs | Azure generic WEB app template. |

### <a name="plugins"></a>Plugins

Extend or merge the Squeezer framework functionality with plugins

| Plugin | Author |
|-----|--------------|
|**[AWS Plugin](https://github.com/SqueezerIO/squeezer-aws)** <br/> This plugin enables AWS Lambda support within the Squeezer Framework. | [Nick Chisiu](https://github.com/nickchisiu) |
|**[Azure Plugin](https://github.com/SqueezerIO/squeezer-azure)** <br/> This plugin enables Azure Functions support within the Squeezer Framework. | [Nick Chisiu](https://github.com/nickchisiu) |
|**[Serve Plugin](https://github.com/SqueezerIO/squeezer-serve)** <br/> This plugin enables serving support for local development within the Squeezer Framework. | [Nick Chisiu](https://github.com/nickchisiu) |
|**[Swagger Plugin](https://github.com/SqueezerIO/squeezer-swagger)** <br/> This plugin enables Swagger API Documentation support within the Squeezer Framework. | [Nick Chisiu](https://github.com/nickchisiu) |

### <a name="example-projects"></a>Example Projects

| Project Name | Author | Demo |
|-------------|------|---------|
| **[AWS Generic API Project](https://github.com/SqueezerIO/example-projects/aws-api-nodejs)** <br/> AWS generic API Hello World projects using Swagger API Docs | [Nick Chisiu](https://github.com/nickchisiu) | demo |
| **[AWS Generic WEB Project](https://github.com/SqueezerIO/example-projects/aws-web-nodejs)** <br/> AWS NodeJS WebApp template + Pug ( ex-Jade ) + ReactJS support + Material UI + Bootstrap 3 styling | [Nick Chisiu](https://github.com/nickchisiu) | demo |
| **[AWS REST API Project](https://github.com/SqueezerIO/example-projects/aws-api-nodejs-rest)** <br/> AWS NodeJS REST API template + DynamoDB + Swagger support | [Nick Chisiu](https://github.com/nickchisiu) | demo |
| **[Azure Generic API Project](https://github.com/SqueezerIO/example-projects/azure-api-nodejs)** <br/> Azure generic API Hello World projects using Swagger API Docs | [Nick Chisiu](https://github.com/nickchisiu) | demo |
| **[Azure Generic WEB Project](https://github.com/SqueezerIO/example-projects/azure-web-nodejs)** <br/> Azure NodeJS WebApp template + Pug ( ex-Jade ) + ReactJS support + Material UI + Bootstrap 3 styling | [Nick Chisiu](https://github.com/nickchisiu) | demo |
| **[Azure REST API Project](https://github.com/SqueezerIO/example-projects/azure-api-nodejs-rest)** <br/> Azure NodeJS REST API template + Azure SQL + Swagger support | [Nick Chisiu](https://github.com/nickchisiu) | demo |


### <a name="getting-started"></a>Getting started

NOTE: **Windows** users should [enable symlinks](http://answers.perforce.com/articles/KB/3472/?q=enabling&l=en_US&fs=Search&pn=1) in order to avoid unwanted symbolic links errors .

#### Run

|    | cmd | description  |
|----|-----|--------------|
| 1. | **npm install -g squeezer-cli**  |  Install Squeezer CLI |
| 2. | **sqz create --project my-first-project --template aws-api-nodejs --email you@example.org**  |  Create a project |
| 3. | **cd my-first-project**  |  Switch to the project's directory |
| 4. | [Configure credentials](https://docs.squeezer.io/clouds/aws/credentials.html)  |  Cloud credentials |
| 5. | **sqz install**  |  Install project's required packages |
| 5. | **sqz compile**  |  Compile project's microservices |
| 7. | **sqz serve**  |  Development mode<br>*NOTE* : Live reload enabled by default |

#### Deploy

|    | cmd | description  |
|----|-----|--------------|
| 1. | **sqz compile --cloud**  |  Compile microservices for cloud deployments |
| 2. | **sqz deploy --stage dev**  | Deploy your app into the cloud provider<br>*Note*: initial deployments can take longer <= **40 mins** |


### <a name="contributing"></a>Contributing

See [contributing.md](CONTRIBUTING.md) for contribution guidelines

## <a name="community"></a>Community

* [Squeezer issues](https://github.com/SqueezerIO/squeezer/issues)
* [Gitter Chatroom](http://chat.squeezer.io/)
* [Facebook](https://www.facebook.com/Squeezer.IO/)
* [Twitter](https://twitter.com/SqueezerIO)
* [Contact Us](mailto:nick@squeezer.io)

---
_Source: https://npm.io/package/squeezer-metabaron · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
