Use Neon with Koyeb

Koyeb is a developer-friendly, serverless platform designed to easily deploy reliable and scalable applications globally. Koyeb offers native autoscaling, automatic HTTPS (SSL), auto-healing, and global load-balancing across their edge network with zero configuration.

This guide describes how connect a Neon PostgreSQL database to an application deployed with Koyeb. To follow the instructions in this guide, you require:

• A Koyeb account to deploy the application. Alternatively, you can install the Koyeb CLI if you prefer to deploy the application from your terminal.
• A Neon account to deploy the PostgreSQL database.

The example application connects to your Neon PostgreSQL database using Prisma as an ORM. Prisma synchronizes the database schema with the Prisma schema included with the application and seeds the database.

Create a Neon project

1. Navigate to the Neon Console.
2. Select Create a project.
3. Enter a name for the project (neon-koyeb, for example), and select a PostgreSQL version and region.
4. Click Create project.

A dialog pops up with your Neon connection string, which appears similar to the following:

postgres://<user>:<password>@<host>:<port>/neondb

Store this value in a safe place. It is required later. The connection string specifies neondb as the database. This is the default database created with each Neon project. You will use this database with the example application.

Deploy the application on Koyeb

You can deploy on Koyeb using the control panel or the Koyeb CLI.

From the Koyeb control panel

To deploy the application from the Koyeb control panel, follow these steps:

1. Select Create App.
2. Select GitHub as the deployment method.
3. Enter https://github.com/koyeb/example-express-prisma in the Public GitHub repository field.
4. Keep example-express-prisma as the name and main as the branch.
5. In Build and deployment settings, enable the Override setting and add the following Build command: npm run postgres:init
6. Select the region closest to your Neon database.
7. Under Advanced > Environment variables, add a DATABASE_URL environment variable to enable the application to connect to your Neon PostgreSQL database. Set the value to the Neon connection string provided to you when you created the Neon project.
8. Enter a name for your app. For example, express-neon
9. Click Deploy.

Koyeb builds the application. Once the build and deployment have finished, you can access your application running on Koyeb by clicking the URL ending with .koyeb.app.

The example application exposes a /planets endpoint that you can use to list planets from the database. Once your deployment is live, you should see the following results when navigating to https://<YOUR_APP_URL>.koyeb.app/planets:

[
{
    "id": 1,
    "name": "Mercury"
},
{
    "id": 2,
    "name": "Venus"
},
{
    "id": 3,
    "name": "Mars"
}
]

From the Koyeb CLI

The Koyeb CLI requires an API access token, which you can generate in the Koyeb control panel, under Account > API.

To deploy the example application using the Koyeb CLI, run the following command in your terminal.

koyeb app init express-neon \
--git github.com/koyeb/example-express-prisma \
--git-branch main \
--git-build-command "npm run postgres:init" \
--ports 8080:http \
--routes /:8080 \
--env PORT=8080 \
--env DATABASE_URL="postgres://<user>:<password>@<host>:5432/neondb"

Make sure to replace <user>, <password>, and <host> with your Neon connection string values.

Access Koyeb deployment logs

To track the app deployment and visualize build logs, execute the following command:

koyeb service logs express-neon/express-neon -t build

Access your app

Once the build and deployment have finished, you can retrieve the public domain to access your application by running the following command:

$ koyeb app get express-neon
ID          NAME         STATUS         DOMAINS                                CREATED AT          
b8611a1d    express-neon HEALTHY        ["express-neon-myorg.koyeb.app"]       16 Feb 23 18:13 UTC

The example application exposes a /planets endpoint that you can use to list planets from the database. Once your deployment is live, you should see the following results when navigating to https://<YOUR_APP_URL>.koyeb.app/planets:

[
{
    "id": 1,
    "name": "Mercury"
},
{
    "id": 2,
    "name": "Venus"
},
{
    "id": 3,
    "name": "Mars"
}
]

Delete the example application and Neon project

To delete the example application on Koyeb to avoid incurring any charges, follow these steps:

1. From the Koyeb control panel, select the App to delete.
2. On the Settings tab, select Danger Zone and click Delete.

To delete your Neon project, refer to Delete a project.