church-website/README.md
2024-12-05 09:36:47 +01:00

52 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 MongoDB.
## Getting Started
### Prerequisites
- Node.js and npm: Make sure you have Node.js and npm installed on your machine.
- MongoDB: You'll need a MongoDB database to store the website data.
### MongoDB
If you don't have docker on system installed, please
follow the instructions for your operating system on the Docker website.
To pull the MongoDB docker image:
```bash
docker pull mongodb/mongodb-community-server:latest
```
To Run the image as a Container
```bash
docker run --name mongodb -p 27017:27017 -d mongodb/mongodb-community-server:latest
```
### Postgres Database
You will need the an Postgres database including the postgis extension
```bash
docker pull postgis/postgis
```
### 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