Create a Pulse Starter Project on railway.app

This project is used together with the prisma/pulse-railway-pg-config repo to build a template on railway.app. However, you can use this project as a basic Pulse starter project by cloning this repo locally and connecting it to any Pulse-ready Postgres database.

Pulse is currently in early access. Please sign up here or join our discord and reach out to a developer advocate.

Once the template is deployed

You will need to follow the steps from the prisma/pulse-railway-pg-config README to get started. Once you have finished the "How to connect Pulse to your database" section, you can return here.

Railway.app setup

Once you have connected your database to your Pulse project, you will be able to create an API Key. See the documentation.
With your API_KEY, you can return to your railway.app project.
Click on the service called pulse-railway-starter.

Note: Most likely, the build failed. This is because the database was not ready when the Pulse connection was made. Do not worry; this is to be expected.
Click on the Variables tab.
You will see a variable called PULSE_API_KEY. If you do not have that variable, create it.
Click the three verticle dots on the PULSE_API_KEY row and select Edit.
Paste in the API_KEY and click the check mark.

Rebuild the service

Click on the Deployments tab.
Click on the three verticle dots on the deployment that failed. Then click Redeploy.
When the deployment starts, click the View Logs button.
Then click on the Deploy Logs tab.
If everything is set up properly, you should see a message that looks like the following.
```
Hello from   12fcb1f8adc06640f7d89483bb4ce89d7b3cf7444df7b34ea5b706ed8919a6e6
```

This means that your Pulse project is running and listening for events from your database.

See an event in action

Click on your Postgres database in your railway.app project.
It should open on the data tab.
Click the `user table and click Add Row.
Fill out an email and name fields, then click insert.
Return to the logs of your pulse-railway-starter service.
You should be able to see an output from Pulse for the user being created. Something similar to the following.
```
just received an event: {
   action: 'create',
   after: { id: 1, email: 'test', name: 'test@test.io' }
}
```

Congrats! You now have a Pulse project up and running on railway.app

Local development

If you used the Railway template, you can clone the repo in your GitHub account that is a fork of this repo. Otherwise, you can clone this repo directly.

You will need to add your DATABASE_URL and PULSE_API_KEY to a .env file in the root of the project.

You can then run the following command to get started.

npm install
npx prisma migrate dev --name init
npx ts-node index.ts

luanvdw/pulse-run-1