Skip to content

Latest commit

 

History

History
151 lines (97 loc) · 7.77 KB

README.md

File metadata and controls

151 lines (97 loc) · 7.77 KB
Raw

Nitric Logo

Effortless backends with infrastructure from code

GitHub release (latest SemVer) GitHub GitHub Workflow Status Codecov Discord

Nitric is a multi-language framework, with concise inline infrastructure from code. Modern applications should be robust, productive and a joy to build. Nitric solves common problems building for modern platforms:

We also know abstraction should mean building on existing layers, not hiding them. Nitric includes powerful escape hatches for when things get custom.

Supported Languages

Supported Clouds

These are supported out of the box, but you can also build custom providers as well

🧑‍💻 Get started

💿 Install Nitric:

macOS:

brew install nitrictech/tap/nitric

Linux:

curl -L "https://nitric.io/install?version=latest" | bash

Windows:

scoop bucket add nitric https://github.com/nitrictech/scoop-bucket.git
scoop install nitric

🚀 Start building your first app:

nitric new

🕹 See our example apps: Example Apps Repo.

📚 Prefer a walkthrough? Read through our guides.

👋 Any questions? Join our developer community on Discord.

⭐ Give us a star to help support our work!

🍿 Visual Learner?

To get up to speed quickly, take a look at our quick intro to Nitric.

🤷 So.. how does it work?

Nitric focuses on what you want to achieve as the developer:

What workflow do you need to be productive?

What system design are you trying to achieve?.

All you need to do is write your application code and your infrastructure requirements are inferred. Nitric then orchestrates and configures the deployment of your application, no need to manually write your Terraform or other IaC code. By abstracting these infrastructure requirements, it removes the need to write boilerplate and means your single application is portable across clouds including, AWS, GCP, and Azure.

And, it's all open-source

📝 Example: Note Taking

Creating production-ready services and resources is simple, with less than 10 lines to deploy an API endpoint and a bucket with all the IAM permissions automatically configured.

import { api, bucket } from "@nitric/sdk";

const main = api("main");
const notes = bucket("notes").allow("read", "write");

main.post("/notes/:title", async (ctx) => {
  const { title } = ctx.req.params;
  await notes.file(title).write(ctx.req.text());
});

This is the only code needed to deploy a working application to any cloud provider using nitric up. Nitric can deploy this application using automatically generated Pulumi, Terraform or any other automation tools of your choice.

Why use Nitric?

  1. Developer-Centric Workflow Nitric lets you design your application architecture, independent of the deployment automation tool or target platform. With highly declarative in-app infrastructure requirements.

  2. Making Implicit Requirements Explicit If your app needs storage, a database, or a message queue, Nitric ensures these resources are properly set up and integrated into your app, removing the friction of manual configuration.

  3. Cloud-Agnostic and Portable Nitric decouples your application from the underlying cloud infrastructure. Whether you're using AWS, Azure, GCP, or Kubernetes, Nitric allows you to map your application's requirements to the appropriate services across platforms.

  4. Automated Infrastructure, Best Practices Included One of the most error-prone aspects of cloud development is managing permissions, configurations, and security policies. Nitric automates this, making security best practices—like least privilege access and proper service configurations easy.

  5. Focus on Application Logic Nitric's approach allows you to focus on building your application, instead of the scaffolding required to run it in the cloud. By removing the manual steps from the IaC process, Nitric eliminates significant boilerplate and reduces the runtime checking needed to handle configuration errors.

  6. Plugin-Based Architecture Nitric's plugin-based architecture allows you to use the deployment plugins we provide, which use Pulumi or Terraform for deployment, or write your own. This flexibility allows you to use the tools you're comfortable with, while still benefiting from Nitric's infrastructure automation and cloud-agnostic approach.

Want more?

Nitric has full documentation at nitric.io/docs, including concepts, reference documentation for various languages and many tutorials/guides.

Contributing

We greatly appreciate contributions, consider starting with the contributions guide and a chat on Discord or GitHub.