cmslabs / nitric Goto Github PK

A fast & fun way to build portable cloud-native applications

Nitric is a framework for rapid development of cloud-native and serverless applications. Define your apps in terms of the resources they need, then write the code for serverless function based APIs, event subscribers and scheduled jobs.

Apps built with Nitric can be deployed to AWS, Azure or Google Cloud all from the same code base so you can focus on your products, not your cloud provider.

Nitric makes it easy to:

• Create smart serverless functions and APIs
• Build reliable distributed apps that use events and/or queues
• Securely store, retrieve and rotate secrets
• Read and write files from buckets

The full documentation is available at nitric.io/docs.

We're completely opensource and encourage code contributions.

Nitric is currently in Public Preview. Anyone can use or deploy applications, but work remains and changes are likely. We’d love your feedback as we build additional functionality!

• Ask questions in GitHub discussions

• Find us on Twitter

• Send us an email

The Membrane is at the heart of the solution. Nitric applications communicate with the Membrane via gRPC to access the following services in a provider agnostic way:

• Events
• Queues
• Storage & Buckets
• Document Store
• Secret Store

We provide an expressive infrastructure-as-code style SDK for Node.js. However, Nitric is built on gRPC, so support for many languages is possible.

If you have additional languages you'd like supported, let us know in the issues, we also welcome community contributions for new language support.

• Git
• Golang (1.16)
• Make
• Docker
• Google Protocol Buffers Compiler

make install-tools

Download the Google Protobuf Compiler (standalone binary called protoc) from https://github.com/protocolbuffers/protobuf and add it to your $PATH.

On MacOS with Homebrew, you can run brew install protobuf On Fedora, run sudo dnf install -y protobuf protobuf-compiler protobuf-devel

make test

make test-integration

Linux support only - used in container images and for production.

make aws-static

Useful for local testing

make aws-static-xp

make aws-docker

Linux support only - used in container images and for production.

make gcp-static

Useful for local testing

make gcp-static-xp

make gcp-docker

Note: the Dev Membrane should only be used for local development and testing.

The dev binary is always cross-platform, since it doesn't need to be optimized for production deployments.

make dev-static

make dev-docker

To run the membrane server locally, perform a local build of the membrane binary for the platform you're targeting, then run the resulting binary.

# Make the GCP Static Cross-platform binary
make gcp-static-xp

# Run the membrane binary
./bin/membrane

Note: for the AWS membrane, the Lambda Gateway (default) will fail to start. Instead, set the GATEWAY_ENVIRONMENT environment variable so that the HTTP gateway is launched instead.

# Make the AWS Static Cross-platform binary
make aws-static-xp

# Set environment variable in subshell, then run the membrane binary
(export GATEWAY_ENVIRONMENT=http; ./bin/membrane)

It can be useful to run the Membrane in a 'service only' mode, where the cloud APIs are available but you don't need/want to start a child process to handle incoming request. This can be achieved by setting the MIN_WORKERS variable to 0:

(export MIN_WORKERS=0; ./bin/membrane)

The Membrane project source code structure is outlined below:

Examples of projects built with Nitric:

• Identity verification APIs
• FinTech APIs with complex business rules
• Move from Express.js or koa to serverless and distributed architectures
• Migrate from on-prem to the cloud (AWS, Azure or GCP)

Even though your apps are portable across clouds, they'll still make the best use of the fully-managed and serverless offerings of each cloud provider. Nitric deploys using services like Lambda, CloudRun, DynamoDB, FireStore, CosmosDB, SNS, Event Grid, PubSub... the list is super long. Nitric also makes sure IAM and other access is correctly configured in your deployed applications, so everything stays secure and just works.