Skip to content

Latest commit

 

History

History

neon

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Nitric Logo

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

GitHub release (latest SemVer) Twitter Follow Discord

Project Description

This project demonstrates how to combine the power of an auto-scaling api with an auto-scaling db.

Neon is a fully managed serverless PostgreSQL. Neon separates storage and compute and offers modern developer features such as serverless, branching, bottomless storage, and more.

Usage

Step 1: Install Nitric

Follow the steps in the installation guide

Step 2: Create a Neon project

If you do not have one already, create a Neon project.

Navigate to the Projects page in the Neon Console -> Click New Project. Specify your project settings and click Create Project.

Step 3: Configure db env

Create a .env file from .env.template and update the db url, you'll want to use the pooled url since Neon suggests that this will work better with serverless functions.

Step 4: Run your project locally Nitric

Refer to the README located in the language specific version of this project.

Step 5: Test the API

curl https://localhost:4001/version
[
  {
    "version": "PostgreSQL 15.2 on x86_64-pc-linux-gnu, compiled by gcc (Debian 10.2.1-6) 10.2.1 20210110, 64-bit"
  }
]

This simple example queries the version of the database, next steps involve modifying the DB and building your app!

About Nitric

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 and retrieve secrets
  • Read and write files from buckets

Documentation

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

We're completely open-source and encourage code contributions.

Get in touch