Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add pulse railway starter app+ db docs #5734

Merged
merged 36 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
dec6280
feat: add pulse railway starter app+ db docs
ankur-arch Mar 19, 2024
f7bbd50
Optimised images with calibre/image-actions
github-actions[bot] Mar 19, 2024
a46fce8
enhance: fix typo
ankur-arch Mar 19, 2024
e62bede
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 20, 2024
0940326
doc: refine railway docs
ankur-arch Mar 20, 2024
a6b053b
feat: refine further
ankur-arch Mar 21, 2024
f398c1e
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
2f3ab27
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
7c729b8
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
78bb8bc
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
f3e71a2
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
828d28a
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
a2ba7c9
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
dd001ca
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
811dfa3
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
18de157
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
f82c224
docs: refine steps for enhance pulse db and app docs
ankur-arch Mar 21, 2024
ce785c2
Optimised images with calibre/image-actions
github-actions[bot] Mar 21, 2024
21e8386
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
62d3d4e
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
f568c1d
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
c1d2d8f
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
5bab716
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
03f8796
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
b94a9a3
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
48e3a11
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
ef92407
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
5761313
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
9409f47
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
6c424d3
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
caba671
Update content/400-pulse/250-database-setup/300-railway.mdx
ankur-arch Mar 21, 2024
57c9ab0
enhance: refine content further
ankur-arch Mar 22, 2024
d55b360
Merge branch 'main' into railway-update
ankur-arch Mar 22, 2024
586eeab
feat: refine a bit further
ankur-arch Mar 22, 2024
99d279b
feat: further refinements
ankur-arch Mar 22, 2024
6fab98f
Merge branch 'main' into railway-update
ankur-arch Mar 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 41 additions & 3 deletions content/400-pulse/250-database-setup/300-railway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ toc: true

4. Click the most recent build's **View Logs** button.
ankur-arch marked this conversation as resolved.
Show resolved Hide resolved

5. Click on the **Deploy Logs** tab.
5. Click on the **Deploy Logs** tab. If the service ran correctly, you should see a message in the logs that says "All done please restart the database" along with your `DATABASE_URL` connection string.

> If the service ran correctly, you should see a message in the logs that says "All done please restart the database" along with your `DATABASE_URL` connection string.
> **Note**:
> The `DATABASE_URL` can also be found by clicking on the **Postgres** Service and navigating to the **Variables** tab, then clicking the copy icon next to `DATABASE_URL` environment variable value.
> ![](../images/railway-database-url.png)

6. Copy the `DATABASE_URL` connection string and save it for later. Then restart your Railway database.

Expand All @@ -43,7 +45,7 @@ toc: true

8. Scroll down to the bottom and click the red **Delete Service** button.

> Note: If you would like to use this service and the corresponding repository to create a new Prisma Pulse project. You can do so by cloning the repo from your GitHub account to your local machine.
> **Note**: If you would like to use this service and the corresponding repository to create a new Prisma Pulse project. You can do so by cloning the repo from your GitHub account to your local machine.

- Once you have cloned the repository, you can run the following command:

Expand All @@ -57,6 +59,42 @@ toc: true

> This is to prevent the script from running every time you push up to the repo associated with the `restart-db-then-delete-me` service.

If you've deployed the [Prisma Pulse DB & App](https://railway.app/template/pulse-starter) template on Railway and completed the database setup, you can proceed to the next section.

### Setup using the template including the starter app
ankur-arch marked this conversation as resolved.
Show resolved Hide resolved

If you're using the [Prisma Pulse DB & App](https://railway.app/template/pulse-starter) template on Railway and have set up the database on Railway following the steps [above](/pulse/database-setup/railway#setup-using-the-template), proceed with setting up the `pulse-starter` service on Railway by following these steps:

1. Click on the **pulse-starter** service.
> **Note**: You'll likely find that the build failed for the **pulse-starter** service. This is because the Prisma Pulse API key wasn't provided as the database wasn’t Prisma Pulse ready.
ankur-arch marked this conversation as resolved.
Show resolved Hide resolved
> Do not worry, this is to be expected and not a problem for the next steps.
ankur-arch marked this conversation as resolved.
Show resolved Hide resolved
2. Click on the **Variables** tab.
3. Manage your `PULSE_API_KEY` environment variable:
1. If you do not have the variable, click the **New Variable** button, create the `PULSE_API_KEY` environment variable, and then paste the `API_KEY`. Then save the changes by clicking the **Add** button.
ankur-arch marked this conversation as resolved.
Show resolved Hide resolved
2. If you see a variable called `PULSE_API_KEY`. Click the three vertical dots on the `PULSE_API_KEY` row and select **Edit**. Paste in the `API_KEY` and click the check mark icon (☑️).
4. Rebuild the **pulse-starter** service
1. Click on the **Deployments** tab.
2. Click on the three verticle dots on the deployment that failed. Then click **Redeploy**.
3. When the deployment starts, click the **View Logs** button.
4. Then click on the **Deploy Logs** tab.
ankur-arch marked this conversation as resolved.
Show resolved Hide resolved
5. See an event in action
- Click on the **Postgres** service on your railway.app project.
- Click on the **Data** tab.
- Click the `User` table and click **Add Row**.
- Fill out an email and a name, then click **Insert**.
- Return to the **Deploy Logs** of your **pulse-starter** service.
- You should be able to see an output from Prisma Pulse for the user being created:
```json
just received an event: {
action: "create",
created: { id: 1, email: "test", name: "[email protected]" },
id: 03/34334,
modelName: "User"
}
```

- Congrats 🎉! You should have a Prisma Pulse project up and running on **[railway.app](https://railway.app/template/railway.app)**.

## Setup without using a template

<br />
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading