Meta tags:
description= Build cloud backends that run anywhere, fast.;
Headings (most frequently used words):
deploy, resources, nitric, documentation, get, started, build, languages, reference, misc, services, deployment, plugins, providers, projects, cli, local, development, extension, escape, hatches, what, next, new, start, tear, down, runtime, overriding, full, customization, additional,
Text of the page (most frequently used words):
you (53), api (51), nitric (47), the (47), #services (26), your (26), bucket (26), can (24), file (23), route (21), with (19), and (18), secret (18), resources (17), delete (16), sql (15), get (14), deploy (14), websocket (14), like (13), copied (12), copy (12), apis (12), overview (12), start (11), that (11), aws (11), schedules (11), topics (11), queues (11), put (11), queue (11), topic (11), job (11), providers (10), terraform (10), new (10), websockets (10), key (10), value (10), stores (10), schedule (10), more (9), service (9), provider (9), run (9), read (9), storage (9), secrets (9), foundations (8), this (8), for (8), use (8), cloud (8), databases (8), iac (8), deployment (7), section (7), are (7), pulumi (7), project (7), code (7), all (7), name (7), batch (7), patch (7), post (7), local (6), projects (6), have (6), doesn (6), but (6), python (6), about (6), azure (6), version (6), guides (5), support (5), page (5), need (5), set (5), example (5), const (5), sdk (5), from (5), import (5), dart (5), typescript (5), javascript (5), access (5), files (5), down (5), stack (5), create (5), yaml (5), them (5), google (5), write (5), websites (5), github (4), escape (4), development (4), cli (4), resource (4), any (4), build (4), how (4), want (4), also (4), interact (4), without (4), app (4), command (4), custom (4), apps (4), every (4), send (4), dequeue (4), enqueue (4), subscribe (4), publish (4), keys (4), submit (4), handler (4), search (4), what (3), extension (3), into (3), quick (3), always (3), would (3), using (3), makes (3), built (3), tool (3), own (3), directly (3), work (3), everything (3), even (3), buckets (3), locally (3), don (3), tear (3), tools (3), installation (3), one (3), might (3), match (3), clouds (3), anywhere (3), why (3), they (3), async (3), main (3), close (3), cron (3), connectionstring (3), latest (3), server (2), follow (2), contributions (2), 2026 (2), edit (2), next (2), hatches (2), plugins (2), introduction (2), building (2), guide (2), way (2), just (2), language (2), platform (2), here (2), deploys (2), runtime (2), extend (2), east (2), region (2), s3client (2), some (2), many (2), common (2), provides (2), dashboard (2), test (2), architecture (2), entrypoints (2), mean (2), runs (2), recommend (2), reading (2), generates (2), generate (2), where (2), target (2), once (2), features (2), requested (2), has (2), docker (2), which (2), install (2), look (2), then (2), each (2), container (2), npm (2), dev (2), service_path (2), most (2), languages (2), differences (2), plugin (2), between (2), request (2), profiles (2), jump (2), hello (2), res (2), req (2), infrastructure (2), documentation (2), getuploadurl (2), getdownloadurl (2), exists (2), http (2), messaging (2), docs (2), youtube, join, our, discord, inc, last, updated, jan, open, issue, feedback, dive, depth, tutorials, checkout, out, detailed, easier, additional, included, written, bit, advanced, ultimate, hatch, full, customization, swaps, sns, eventbridge, change, interacts, modify, overriding, listobjectsv2, await, contents, normally, client, will, ways, vast, cover, shouldn, unique, enough, abstraction, disservice, aims, make, table, stakes, easy, never, limit, trigger, waiting, publisher, upload, produces, live, diagram, updates, hosts, well, sometimes, binds, environment, syncs, wifi, machine, desert, island, deployments, used, destroy, currently, while, others, existing, hcl, cases, generated, preferred, apply, emulates, template, few, dependencies, nitrictech, tap, brew, linux, windows, macos, help, manage, installing, options, below, package, json, users, orders, structure, something, uses, find, turns, mode, gives, result, either, automatically, restrictions, libraries, mostly, anything, root, several, prefer, prod, abstracts, away, layer, focus, part, possible, call, important, think, should, different, designed, independent, gcp, kubernetes, cluster, single, could, multiple, collects, when, choose, creates, links, together, allow, blocks, etc, type, handles, matched, becomes, allowing, scale, independently, heart, serve, handlers, subscribers, lot, telling, otherwise, keep, learn, core, elements, already, familiar, sections, consider, starting, straight, action, body, ctx, params, supports, basically, missing, applications, automation, however, helps, pluggable, swap, whole, changing, declarative, framework, backends, fast, faq, examples, misc, containers, env, vars, other, config, preview, reference, sqldatabase, uploadurl, downloadurl, listfiles, accessversion, newroute, newwebsocket, newschedule, newtopic, newbucket, newsqldatabase, newsecret, newqueue, newkv, newjob, newapi, connection_string, upload_url, download_url, methods, node, adding, types, mappings, hpc, security, configuration, started, welcome,
Text of the page (random words):
welcome to nitric nitric documentation foundations guides search search docs 1 9k search search docs introduction get started installation quick start guides foundations why nitric projects overview configuration infrastructure overview services resources security local development deployment architecture overview services apis schedules websockets websites storage key value stores async messaging queues topics sql databases secrets build apis batch ai ml hpc schedules websockets websites storage key value stores sql databases async messaging secrets deploy overview pulumi overview aws google cloud azure terraform overview aws google cloud azure service mappings aws apis batch schedules websockets websites storage key value stores sql databases topics queues secrets azure apis schedules websites storage key value stores sql databases topics queues secrets google cloud apis batch schedules websites storage key value stores sql databases topics queues secrets custom overview provider extension custom providers adding resource types install with docker languages overview node js overview apis api api get api post api put api delete api patch api route api route all api route get api route post api route put api route delete api route patch batch job job handler job submit http http key value stores kv kv get kv set kv delete kv keys topics topic topic publish topic subscribe queues queue queue enqueue queue dequeue secrets secret secret put secret version secret latest secret version access storage bucket bucket on bucket file bucket files file exists file read file write file delete file getdownloadurl file getuploadurl sql sql sql connectionstring schedules schedule schedule every schedule cron websockets websocket websocket on websocket send websocket close python overview apis api api get api post api put api delete api patch api methods api all batch job job handler job submit key value stores kv kv get kv set kv delete kv keys topics topic topic publish topic subscribe queues queue queue enqueue queue dequeue secrets secret secret put secret version secret latest secret version access storage bucket bucket on bucket file bucket files file read file write file delete file download_url file upload_url sql sql sql connection_string schedules schedule websockets websocket websocket on websocket send go overview resources newapi newjob newkv newqueue newsecret newsqldatabase newbucket newtopic newschedule newwebsocket apis api get api post api put api delete api patch api newroute api route all api route get api route post api route put api route delete api route patch batch job handler job submit key value stores kv get kv set kv delete kv keys topics topic publish topic subscribe queues queue enqueue queue dequeue secrets secret put secret accessversion secret access storage bucket on bucket listfiles bucket read bucket write bucket delete bucket downloadurl bucket uploadurl sql sqldatabase connectionstring schedules schedule every schedule cron websockets websocket on websocket send websocket close dart overview apis api api all api get api post api put api delete api patch api route api route all api route get api route post api route put api route delete api route patch batch job job handler job submit key value stores kv kv get kv set kv delete kv keys topics topic topic publish topic subscribe queues queue queue enqueue queue dequeue secrets secret secret put secret version secret latest secret version access storage bucket bucket on bucket file bucket files file exists file read file write file delete file getdownloadurl file getuploadurl sql sql sql connectionstring schedules schedule schedule every schedule cron websockets websocket websocket on websocket send websocket close reference cli preview features other config env vars custom service containers misc examples faq contributions support nitric documentation build cloud backends that run anywhere fast nitric is a declarative cloud framework with common resources like apis websockets databases queues topics buckets and more however nitric doesn t just deploy the resources it helps you interact with them it also makes them pluggable so you can swap services or even whole clouds without changing your code it s what s missing between applications and infrastructure automation oh and it supports basically any language like javascript typescript python go you name it javascript typescript python go dart services api js copy copied import api from nitric sdk const main api main main get hello name async req res const name req params ctx res body hello name if you re already familiar with nitric you might want to jump to the installation guides or resources sections if you re new to nitric consider starting with the why nitric page or the quick start guide if you want to jump straight into the action otherwise keep reading to learn more about the core elements of nitric services services are the heart of nitric apps they re the entrypoints to your code they can serve as apis websockets schedule handlers subscribers and a lot more you create services by telling nitric where to look for your code and how to run it nitric yaml copy copied name example services match services ts start npm run dev services service_path you might have one service that handles everything or a service for each route it s up to you every matched service becomes a container allowing them run and scale independently resources resources are the building blocks of your apps they re the databases queues buckets etc that your services interact with to request a resource import the resource type and create one with a name javascript typescript python go dart services example js copy copied import bucket from nitric sdk const profiles bucket profiles allow read write delete nitric collects everything your services request when you deploy the deployment plugin you choose creates the resources and services then links them all together deployment plugins providers nitric is designed to be independent of any platform so you can run your apps anywhere you can deploy to aws azure gcp your own kubernetes cluster or a single server you could even deploy to multiple clouds at once are the differences between a bucket on aws and a bucket on azure important to most apps we don t think so so why should the code be different nitric abstracts away api layer differences so you can focus on your app the part that makes that possible is a plugin we call a provider aws pulumi azure pulumi google pulumi aws terraform google terraform custom nitric prod yaml copy copied provider nitric aws 1 1 1 region us east 1 we have several providers built in with iac from pulumi or terraform but you can build your own with any tools you prefer and deploy anywhere projects projects built with nitric don t have many restrictions you can use most languages libraries tools clouds services mostly anything you like but you need to have a nitric yaml file in the root of your project nitric yaml copy copied name example services match services ts start npm run dev services service_path nitric uses this to find your services then it turns each service into a container runs them in deployment mode to match the resources you requested and gives the result to the provider which either generates iac like terraform or automatically deploys your app so a project structure might look something like this javascript typescript python go dart copy copied example nitric yaml services orders js users js package json you can read more about how nitric projects work in the foundations section cli nitric has a cli to help you create manage run and deploy your projects we recommend installing it with one of the options below macos windows linux copy copied brew install nitrictech tap nitric nitric has a few dependencies like docker which you can read about in the installation section new you can create a new project from a template with the new command copy copied nitric new start you can run your project locally with the start command copy copied nitric start start also emulates the resources you requested so you can test your app locally it also provides a dashboard ui to interact with the resources you can read about nitric s local development features in the foundations section deploy you can deploy your project with the up command once you have a stack file deployment target copy copied create a new stack deployment target nitric stack new deploy to the stack using the provider in the stack file nitric up some providers deploy directly others generate iac files for existing tools like hcl for terraform in the cases where iac is generated you can use your preferred iac tool to deploy e g terraform apply currently all pulumi providers deploy directly while terraform providers generate iac you can read more about nitric providers in the foundations section tear down you can tear down your project with the down command copy copied nitric down if you used a provider that generates iac use the iac tool to tear down e g terraform destroy we recommend reading more about nitric deployments in the foundations section local development sometimes you ll want to run your app locally we don t mean binds to a cloud environment and syncs your code but doesn t work without wifi local we mean runs on your machine on a desert island local nitric start hosts entrypoints like apis websockets and schedules as well as resources like databases topics queues key value stores and buckets it also provides a dashboard to interact with your resources so you can trigger schedules without waiting or topics without a publisher or upload test files to a bucket it even produces a live architecture diagram of your services and resources as your code updates extension escape hatches the services of cloud providers are vast we can t cover everything and we shouldn t many services are unique enough that abstraction would be a disservice nitric aims to make common table stakes services easy to use but we never want to limit you here are some ways you can extend or escape nitric runtime if you need to access a service in a way nitric doesn t support you can always use the provider s sdk directly code like this will always work javascript typescript python go dart copy copied import the aws sdk import s3client from aws sdk client s3 use it like you normally would const s3 new s3client region us east 1 const contents await s3 listobjectsv2 bucket my bucket overriding if you need to change how nitric deploys a resources or how it interacts with a service at runtime you can extend or modify a provider for example here s a project that swaps sns for eventbridge on aws full customization if you need to deploy to a new platform or new set of services that nitric doesn t support you can build your own provider this is a bit more advanced but it s the ultimate escape hatch the included providers are written in go and built using terraform or pulumi but you can use any language or tool you like additional resources if you need to use a service resource that nitric doesn t support you do that like you always would nitric doesn t get in the way of you using the cloud it just makes it easier what s next start building with the quick start guide checkout out the foundations section for a more detailed introduction to nitric dive into the guides section for more in depth tutorials edit this page on github have feedback on this page open github issue last updated on jan 5 2026 on this page services resources deployment plugins providers projects cli local development extension escape hatches what s next edit this page on github 2026 nitric inc contributions support foundations guides follow us on x follow us on github join our discord server youtube
|
