Mim 2404 database schema migration first draft

.github/workflows/testOnPr.js.yml

@@ -1,7 +1,7 @@
 name: Build and test
 on:
   pull_request:
-    branches: [ "develop", "main" ]
+    branches: ["develop", "main"]
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -10,13 +10,14 @@ jobs:
         node-version: [22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
     steps:
-    - uses: actions/checkout@v5
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v6
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm run ci-test
-    - run: npm run lint
+      - uses: actions/checkout@v5
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm ci
+      - run: npm run generate
+      - run: npm run build --if-present
+      - run: npm run ci-test
+      - run: npm run lint

.gitignore

@@ -6,3 +6,10 @@ node_modules
 
 # Ignore coverage folder
 coverage/
+
+# Ignore generate folder, you should make your own. 
+# Use npm run generate
+src/generated/
+
+# Do not commit your .env file, please
+.env

Dockerfile

@@ -14,6 +14,9 @@ RUN npm install
 # Copy the application source code
 COPY . .
 
+# Generate the Prisma client libraries
+RUN npm run generate
+
 # Build the application
 RUN npm run build
 
@@ -25,5 +28,4 @@ EXPOSE 9000
 EXPOSE 8080
 
 # Command to start the application
-# CMD [ "sh", "-c", "npm run db:deploy && npm run start" ]
-CMD [ "sh", "-c", "npm run start" ]
+CMD [ "sh", "-c", "npm run db:deploy && npm run start" ]

README.md

@@ -5,6 +5,7 @@ Statreg API is a backend service for statistikkregisteret. It provides endpoints
 ## DEV
 ```
 npm install
+npm run generate
 npm run dev
 ```
 Go to http://localhost:8080 to see results.
@@ -32,10 +33,10 @@ Help secure Express apps by setting HTTP response headers.
 Express middleware with popular prometheus metrics in one bundle. Exposes `/metrics` endpoint.
 
 ## Docker
-## Prerequisites
+### Prerequisites
 To get started, you first need to [install Colima and Docker CLI.](https://statistics-norway.atlassian.net/wiki/spaces/mimir/pages/4827381761/Bytte+fra+Docker+Desktop+til+Colima)
 
-## Build and run
+### Build and run
 Start Colima with the default configuration
 ```bash
 colima start
@@ -49,4 +50,23 @@ docker build -t ssbno/statreg-api .
 Then, run
 ```bash
 docker run -it -p 8080:8080 ssbno/statreg-api
-```
+```
+
+## Persistence
+
+### Database
+
+We use PostgreSQL, provided by Nais in our live environments. Locally you can set up your own Postgres db in one of many ways - install PostgreSQL [from either the website](https://www.postgresql.org/download/), Homebrew or your package manager of choice. If you are on a mac, postgres.app is recommended and makes setup very easy and quick.
+
+### Prisma
+
+We use Prisma both as our ORM and as our schema migration tool in this project. We strongly recommend reading [this article](https://www.prisma.io/docs/getting-started/setup-prisma/add-to-existing-project/relational-databases/evolve-your-schema-typescript-postgresql) before touching the schema if you have not used Prisma before.
+
+In short though, Prisma handles schema changes with Migrations, which are incremental change sets applied to the database. Applied migrations are recorded in the database. Migrations are generated with the Prisma CLI, checked into the codebase and _never_ manually changed. After having made changes to your schema, you can push these changes to your local db with `npx prisma db push`. Note that this does not update your migrations, but you can do this as many times as you like until the desired state is achieved. (sidenote: this may cause data loss locally)
+
+When you are happy with your updated schema, you can run `npx prisma migrate dev --name name-of-changeset`. This applies previous changes in schema, generates a new migration with the supplied name, applies all unapplied migrations and triggers generation of a new Prisma Client.
+
+There are many fun pitfalls and ways of messing up both your local db and production data using prisma, so educate yourself, make sure you know what you are doing, and be ready to roll back changes.
+
+For local development, we can use a file named ".env" located in the root directory of the project. Currently we only use one environment variable from this file - see prisma.config.ts - and it should look something like this:  
+`NAIS_DATABASE_MYAPP_MYDB_URL="postgresql://<USERNAME>@localhost:5432/statreg_db"`