feat: Dev database with backup and restore scripts

[DafyddLlyr]

What does this PR do?

• Sets up a local development database
• Creates a backup script (make a copy of the prod db)
• Creates a restore script (populate local db)

Comments

This PR sets up a local database, which has a copy of prod data. This means we can make local database changes, test them out, and then deploy those changes to the production database.

We're using Docker to containerise the local database, as well as the "dbtools" service which runs the backup and restore scripts.

In order for this to work, we'll need to use .env.local and .env.production. Both of these files have been added to the Fairhold vault in 1Password - let me know if you have issues accessing these files.

How do I test this out?

You'll need to have do install docker, configure env vars (see above) and then checkout this branch.

From here you should be able to take the following steps -

• Backup the prod db to your local disk (npm run backup)
• Populate your local database (npm run restore)
• Run the app and see it working as expected (npm run dev)
• Checkout Prisma studio for access to the local data (npm run prisma:studio)

Please have a crack at this and we'll talk through all of this on the call Wednesday 👍

Architecture

flowchart LR
    classDef todo stroke-dasharray: 5 5

    subgraph "fairhold-data"
        S1[(Source 1)] <---> Script
        S2[(Source 2)] <---> Script
        S3[(Source 3)] <---> Script
    end

    subgraph "DB tools"
        LD[(Local disk)] --> UpdateData
        LD <--> Backup
        LD --> Restore
    end

    subgraph "Local development"
        NextLocal[Next.js App]
        PrismaLocal[Prisma]
        LocalDB[(Database)]
        PrismaLocal <--> NextLocal
        LocalDB <--> PrismaLocal
    end
    
    subgraph "CI/CD"
        GitHub["GitHub actions"]:::todo
    end

    subgraph "Production (Vercel)"
        NextProd[Next.js App]
        PrismaProd[Prisma]
        ProdDB[(Database)]
        PrismaProd <--> NextProd
        ProdDB <--> PrismaProd
    end

    Script -- Writes to --> LD
    Restore -- .env.local --> LocalDB
    Backup <-- .env.production --> ProdDB
    UpdateData:::todo -- .env.production --> ProdDB
    
    PrismaLocal -- "Migration files" --> GitHub
    GitHub -- "Merge to main" --> ProdDB

Loading

Next steps...

• Setup Prisma migrations

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
fairhold-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 5, 2024 11:49am

[DafyddLlyr]

I've removed this in favour of calling dotenv-cli in the package.json scripts.

Prisma docs: https://www.prisma.io/docs/orm/more/development-environment/environment-variables/managing-env-files-and-setting-variables#using-dotenv-cli-via-command-line

[zz-hh-aa]

Super exciting, thanks Daf!

Everything works for me locally, though I did run into some errors when running the scripts--I did have to update the end of line sequences from CRLF to LF. Do you know if there's a more OS-agnostic way of handling this?

[DafyddLlyr]

Ah good catch @zz-hh-aa - we can fix this with a .gitattributes files. I'll open a PR to handle this 👍

[zz-hh-aa]

Worked great--thanks Daf 🙌

[gabrielegranello]

Hi @DafyddLlyr I could make it work locally fairly easily, thanks for setting this up!