Meta tags:
description=Getting started guide for an initial Nitric project;

Headings (most frequently used words):

the, started, app, getting, what, next, get, build, deploy, languages, reference, misc, using, new, command, running, locally, making, updates, deploying,

Text of the page (most frequently used words):
the (56), api (55), you (29), file (28), nitric (26), route (23), bucket (19), secret (18), and (16), your (15), can (15), get (15), sql (15), delete (15), websocket (14), new (13), apis (13), overview (12), copied (11), copy (11), put (11), queue (11), topic (11), job (11), this (9), command (9), with (9), stack (9), topics (9), schedule (9), schedules (9), storage (9), secrets (9), key (9), value (9), stores (9), application (8), will (8), cloud (8), for (8), http (8), ctx (8), hello (8), start (8), websockets (8), queues (8), use (7), resources (7), aws (7), provider (7), name (7), services (7), local (7), batch (7), patch (7), post (7), any (6), cli (6), service (6), all (6), databases (6), version (6), server (5), using (5), more (5), deploy (5), automatically (5), set (5), project (5), goodbye (5), dart (5), python (5), install (5), websites (5), github (4), foundations (4), page (4), app (4), about (4), changes (4), like (4), yaml (4), azure (4), john (4), async (4), from (4), javascript (4), typescript (4), dashboard (4), send (4), write (4), read (4), access (4), dequeue (4), enqueue (4), subscribe (4), publish (4), keys (4), submit (4), handler (4), search (4), guides (3), support (3), edit (3), making (3), running (3), learn (3), down (3), when (3), deployed (3), deployment (3), output (3), see (3), now (3), example (3), create (3), that (3), need (3), which (3), testing (3), localhost (3), curl (3), test (3), const (3), helloapi (3), provides (3), development (3), installation (3), started (3), custom (3), close (3), cron (3), every (3), connectionstring (3), files (3), latest (3), google (3), our (2), follow (2), contributions (2), 2026 (2), deploying (2), updates (2), locally (2), what (2), finished (2), typically (2), relevant (2), urls (2), displayed (2), also (2), build (2), configuration (2), options (2), once (2), should (2), directory (2), named (2), dev (2), uses (2), choose (2), different (2), prompts (2), guide (2), plugin (2), then (2), run (2), providers (2), 4001 (2), template (2), hot (2), reloading (2), return (2), body (2), res (2), params (2), req (2), adding (2), templates (2), include (2), look (2), documentation (2), features (2), client (2), other (2), package (2), json (2), world (2), projects (2), getuploadurl (2), getdownloadurl (2), exists (2), messaging (2), quick (2), docs (2), youtube, join, discord, inc, last, updated, jan, open, issue, have, feedback, next, tear, make, again, detect, update, complete, these, interact, console, https, amazon, com, remaining, such, region, east, created, appear, case, but, prefer, help, through, selecting, naming, represents, target, gcp, first, step, configure, credentials, prerequisites, want, implemented, basic, tested, works, one, platforms, applications, built, without, code, thanks, plugins, stop, after, saving, registered, depending, language, may, not, restart, let, add, main, sdk, import, opening, editor, save, execute, default, point, happens, real, time, visualization, along, useful, tools, recommend, taking, its, generated, link, refreshes, details, buckets, etc, are, they, register, themselves, hosted, their, own, port, port_number, offering, emulated, versions, suitable, readme, lock, node_modules, npm, navigate, dependencies, starter, scaffold, here, creating, dependency, information, review, full, nitrictech, tap, brew, linux, windows, macos, before, begin, getting, faq, examples, misc, containers, env, vars, 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, languages, docker, resource, types, extension, mappings, terraform, pulumi, hpc, architecture, security, infrastructure, why, introduction,

Text of the page (random words):
get started quick start 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 getting started before you begin you ll need to install the nitric cli macos windows linux copy copied brew install nitrictech tap nitric for more installation options and dependency information review the full installation guide using the new command the nitric cli s new command provides prompts to scaffold new projects from templates here s an example of creating a new project from a template typescript javascript python go dart copy copied nitric new hello world js starter navigate to the new project directory and install the dependencies typescript javascript python go dart copy copied cd hello world npm install your project should now look like this typescript javascript python go dart copy copied services api js node_modules package lock json package json nitric yaml readme md running the app locally nitric provides a local development server offering emulated versions of cloud services suitable for local development testing you can use the nitric cli to start the local server using the nitric start command copy copied nitric start nitric will automatically run your application using the service start command from the nitric yaml file once your services are running they will register themselves with the server resources like http apis and websockets will be hosted on their own port which will also be displayed in the cli output as http localhost port_number the output will include a link to the local dashboard which automatically refreshes with details about all the resources your application uses e g apis buckets topics databases etc you can use the automatically generated http client in the dashboard or any other http client to test your apis for example you can use curl to test the hello service copy copied curl http localhost 4001 hello john hello john the local dashboard provides real time visualization of the application s resources along with useful testing tools we recommend taking a look at the local dashboard documentation to learn more about its features making updates nitric s project templates typically include hot reloading by default so at this point you can start making changes to services and see what happens start by opening the hello service in your editor and adding a new route to the api then save and execute the file typescript javascript python go dart services api js copy copied import api from nitric sdk const helloapi api main helloapi get hello name async ctx const name ctx req params ctx res body hello name return ctx let s add a goodbye route to the api like this helloapi get goodbye name async ctx const name ctx req params ctx res body goodbye name return ctx depending on the language you choose the template may support hot reloading if not you ll need to restart the service after saving the file the new route will be registered and you can test it copy copied curl http localhost 4001 goodbye john goodbye john when you re finished testing you can stop your application and the nitric server deploying the app now that you ve implemented a basic api and tested that it works you can deploy it to one or more cloud platforms applications built with nitric can be automatically deployed and run to different cloud providers without any code changes thanks to nitric provider plugins the first step is to configure your credentials for the cloud provider and any prerequisites for the provider plugin you want to use aws azure gcp you ll then need to create a stack file which represents a deployment target for your application the stack new command can help you create a new stack file with prompts to guide you through selecting a provider plugin and naming the stack copy copied nitric stack new for this example we ll create a new stack named dev that uses the aws provider but you can choose a different name and provider if you prefer once you ve created your stack file you should see it appear in your project directory as nitric stack id yaml in our case the file is named nitric dev yaml edit this file and set any remaining configuration options such as the region you d like to deploy to e g us east 1 for aws now you can build your application and deploy the stack with the up command copy copied nitric up typically when the deployment is complete any relevant urls will be displayed in the cli output you can use these urls to interact with your api you can also use the relevant cloud console e g https aws amazon com to see the deployed resources to deploy any changes you make to your application you can use the up command again nitric will automatically detect the changes and update the deployed resources when you re finished with your application you can tear it down using the down command copy copied nitric down what s next learn more about apis learn more about the foundations of nitric edit this page on github have feedback on this page open github issue last updated on jan 5 2026 on this page using the new command running the app locally making updates deploying the app 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