/site

Primary LanguageTypeScriptApache License 2.0Apache-2.0

PfadiMH Website

Getting Started

Prerequisites

  1. Install Docker
  2. Install VSCode
  3. Install Remote - Containers extension

Initial Setup

  1. Open the project in VSCode.
  2. Copy the .env.example to .env.
  3. Click on the button in the bottom left corner and select "Reopen in Container".

Development

DevContainer

The devcontainer consists of the following services:

  • Development Container itself
  • PostgreSQL Database
  • Directus CMS

Setup

Before getting started, install the global dependencies:

bun install

Directus Setup

Once the devcontainer is running, you can access the Directus CMS at http://localhost:8055.

To load the schema, run the following command in the terminal:

bun directus-apply

Login with the default credentials admin@example.com and d1r3ctu5.

Create a random new Collection to fix the No Permission error. You can delete it afterwards.

Frontend Setup

  1. In Directus, create a new directus token under Users -> Admin User -> Token.

  2. Copy the token and add it to the .env file as DIRECTUS_TOKEN.

  3. To start the frontend, run the following command in the terminal:

    bun dev --turbo

The frontend is now accessible at http://localhost:3000.

Schema Changes

  1. Create a snapshot of the new schema:

    bun directus-snapshot

  2. Generate types for the new schema (you might have to reload the window after):

    bun gen-types

    This will:

    • Introspect the database and generate the file backend/schema.prisma.
    • Fix the naming of the Prisma schema using prisma-case-format.
    • Generate types for the Prisma client. The generated types are saved in node_modules/.prisma/client/index.d.ts.

Read More