README.md

DBOS Hello

This is a DBOS app bootstrapped with npx @dbos-inc/dbos-sdk init.

Getting Started

Before you can launch your app, you need a database. DBOS works with any Postgres database, but to make things easier, we've provided a script that starts a Docker Postgres container and creates a database. On Linux or Mac, run:

export PGPASSWORD=dbos
./start_postgres_docker.sh

On Windows (cmd), run:

set PGPASSWORD=dbos
start_postgres_docker.bat

If successful, the script should print Database started successfully!.

Then, let's run a schema migration to create some tables:

npx dbos-sdk migrate

If successful, the migration should print Migration successful!.

Next, build and run the app:

npm run build
npx dbos-sdk start

To see that it's working, visit this URL in your browser: https://localhost:3000/greeting/dbos. You should get this message: Hello, dbos! You have been greeted 1 times. Each time you refresh the page, the counter should go up by one!

Congratulations! You just launched a DBOS application.

Next Steps

• To add more functionality to this application, modify src/operations.ts, then re-build and re-start it. For a detailed tutorial, check out our programming quickstart.
• To learn how to deploy your application to DBOS Cloud, visit our cloud quickstart
• To learn more about DBOS, take a look at our documentation or our source code.