50 lines
No EOL
1.3 KiB
Markdown
50 lines
No EOL
1.3 KiB
Markdown
# Heilige Drei Könige Website
|
|
This is the repository for the Heilige Drei Könige Catholic Church website, built using
|
|
Payload CMS v3, NextJS, React and Postges.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
- Node.js and npm: Make sure you have Node.js and npm installed on your machine.
|
|
- Postgres: You'll need a PostgresSQL database to store the website data.
|
|
|
|
|
|
### Postgres Database
|
|
|
|
You will need the an Postgres database including the postgis extension
|
|
|
|
```bash
|
|
docker pull postgis/postgis
|
|
```
|
|
|
|
#### Migration
|
|
|
|
To create a new database migration use:
|
|
|
|
```bash
|
|
yarn payload migrate:create [name]
|
|
```
|
|
|
|
After the changes are pushed to the production server, the migration has to be
|
|
executed on the production database with `yarn payload migrate`
|
|
|
|
Todo: integrate this step in Continious Deployment
|
|
|
|
### Environment variables
|
|
|
|
Please set the environment variables in the `.env` file
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
### Development server
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
## Storybook
|
|
Storybook is a popular open-source tool used for building UI components and pages in isolation. Think of it as a playground for your user interface elements. It allows developers to create, test, and document components independently from the main application.
|
|
|
|
Run `yarn storybook` to view the storybook |