https://github.com/aaronksaunders/payload-railway-postgres

template for running PayloadCMS v2 with PostgreSQL on Railway
https://github.com/aaronksaunders/payload-railway-postgres

payloadcms postgres postgresql railway railway-template

Last synced: about 2 months ago
JSON representation

template for running PayloadCMS v2 with PostgreSQL on Railway

• Host: GitHub
• URL: https://github.com/aaronksaunders/payload-railway-postgres
• Owner: aaronksaunders
• Created: 2023-10-09T20:21:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-10T05:30:56.000Z (over 1 year ago)
• Last Synced: 2023-10-10T23:43:21.141Z (over 1 year ago)
• Topics: payloadcms, postgres, postgresql, railway, railway-template
• Language: TypeScript
• Homepage:
• Size: 176 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Payload CMS v2 with PostgreSQL Database

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/B_KVXT?referralCode=1-iY_G)

The original project was created using `npx create-payload-app` and used the blank template.

## How to Use Locally with Remote PostgreSQL Database

> Following these instructions will have the application pointing to the hosted PostgreSQL database

- `yarn install` to install the needed dependencies

- Install and configure the [Railway CLI](https://docs.railway.app/develop/cli)

- `railway run yarn dev` will start up your application and reload on any changes. At this point changes in the schema will be automatically updated in the remote PostgreSQL database

-  to create migration before committing your code `railway run yarn payload migrate:create`

## How to Use Locally with Local PostgreSQL Database

- `yarn install` to install the needed dependencies

- Create your own local Postgres Database and update the `.env` file with the `DATABASE_URI`

- Set the other `.env` file variables

- `yarn dev` will start up your application and reload on any changes

- Payload will update the database schema locally so you will need to run `railway run yarn payload migrate:create` before committing to GitHub so the schema changes get committed. The deployment script will run the appropriate migrate command to push changes to the database

## PostgreSQL Information

- https://www.postgresql.org/download/

### How To Create a Local PostgreSQL Database

Open the terminal and run the command

```

sudo -u postgres psql

```

Create PostgreSQL Database

```

CREATE DATABASE myproject;

```

Create User

```

CREATE USER myprojectuser WITH PASSWORD 'password';

```

Update the `.env` file variable `DATABASE_URI` appropriately to point to the correct server