Setup CI

.env

@@ -1,3 +1,3 @@
 TZ=UTC
-APP_KEY=gPcUOP5OFpP6fgblb2APfEdyX_fHroZc
+APP_KEY=development-app-key-not-used-in-production
 DATABASE_SERVER=postgres://postgres:@127.0.0.1:5432

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    allow:
+      - dependency-type: 'all'
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/workflows/ci.yml

@@ -0,0 +1,84 @@
+name: CI
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.tool-versions'
+          cache: 'npm'
+      - name: npm
+        run: npm ci
+      - name: lint
+        run: npm run lint
+  schema:
+    runs-on: ubuntu-latest
+
+    env:
+      DATABASE_SERVER: postgres://postgres:postgres@localhost:5432
+
+    services:
+      postgres:
+        image: postgres:15.5-alpine
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: adonisjs_template_development
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 2s --health-timeout 5s --health-retries 5
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.tool-versions'
+          cache: 'npm'
+      - name: npm
+        run: npm ci
+      - name: run migrations
+        run: |
+          node ace db:migrate
+      - name: check git diff
+        run: git diff --exit-code database/types.d.ts
+
+  tests:
+    runs-on: ubuntu-latest
+
+    env:
+      DATABASE_SERVER: postgres://postgres:postgres@localhost:5432
+      NODE_ENV: test
+
+    services:
+      postgres:
+        image: postgres:15.5-alpine
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: adonisjs_template_test
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 2s --health-timeout 5s --health-retries 5
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.tool-versions'
+          cache: 'npm'
+      - name: npm
+        run: npm ci
+      - name: playwright
+        run: npx playwright install chromium
+      - name: run migrations
+        run: |
+          node ace db:migrate
+      - name: tests
+        run: node ace test --coverage

.tool-versions

@@ -0,0 +1 @@
+nodejs v20.16.0

app/services/db.ts

@@ -5,7 +5,7 @@ import env from '#start/env'
 import { databaseConfig } from '#config/database'
 
 const dialect = new PostgresDialect({
-  pool: new PG.Pool(databaseConfig[env.get('NODE_ENV')]()),
+  pool: new PG.Pool(databaseConfig[env.get('NODE_ENV') as keyof typeof databaseConfig]()),
 })
 
 export const globalDb = new Kysely<DB>({

commands/db_migrate.ts

@@ -7,6 +7,8 @@ import type { CommandOptions } from '@adonisjs/core/types/ace'
 import { databaseConfig } from '#config/database'
 import { Cli as kyselyCodegenCli } from 'kysely-codegen/dist/cli/cli.js'
 import env from '#start/env'
+import { default as PG } from 'pg'
+import { promisify } from 'node:util'
 
 export default class KyselyMigrate extends BaseCommand {
   static commandName = 'db:migrate'
@@ -45,7 +47,10 @@ export default class KyselyMigrate extends BaseCommand {
    * Runs migrations up method
    */
   async run() {
-    this.logger.info(`Migrating ${databaseConfig[env.get('NODE_ENV')]().database}`)
+    const config = databaseConfig[env.get('NODE_ENV') as keyof typeof databaseConfig]()
+    const client = new PG.Client(config)
+
+    this.logger.info(`Migrating ${client.database}`)
 
     const { error, results } = await this.migrator.migrateToLatest()
 
@@ -78,8 +83,8 @@ export default class KyselyMigrate extends BaseCommand {
      * Update database types
      */
     this.logger.info('Updating database types with kysely-codegen')
-    const config = databaseConfig[env.get('NODE_ENV')]()
-    const url = `postgres://${config.user}:${config.password}@${config.host}:${config.port}/${config.database}`
+    const url = `postgres://${client.user}:${client.password}@${client.host}:${client.port}/${client.database}`
+
     await new kyselyCodegenCli().generate({
       url,
       dialectName: 'postgres',

config/app.ts

@@ -10,7 +10,7 @@ import { defineConfig } from '@adonisjs/core/http'
  * The encryption module will fail to decrypt data if the key is lost or
  * changed. Therefore it is recommended to keep the app key secure.
  */
-export const appKey = new Secret(env.get('APP_KEY'))
+export const appKey = new Secret(env.get('APP_KEY', 'non-production-app-key'))
 
 /**
  * The configuration settings used by the HTTP server

config/database.ts

@@ -2,8 +2,6 @@ import env from '#start/env'
 import { basename, join } from 'node:path'
 import PG from 'pg'
 
-type DatabaseConfig = Record<string, () => PG.ClientConfig>
-
 const requireEnvVar = (key: string) => {
   const value = env.get(key)
   if (!value) throw new Error(`${key} required for ${env.get('NODE_ENV')}`)
@@ -13,13 +11,13 @@ const requireEnvVar = (key: string) => {
 const appFolderName = basename(join(import.meta.dirname, '..')).replace(/[^\w]+/, '_')
 
 // const type = Record<>
-export const databaseConfig: DatabaseConfig = {
-  production: () => {
+export const databaseConfig = {
+  production: (): PG.ClientConfig => {
     return {
       connectionString: requireEnvVar('DATABASE_URL'),
     }
   },
-  development: () => {
+  development: (): PG.ClientConfig => {
     const url = new URL(requireEnvVar('DATABASE_SERVER'))
     return {
       host: url.hostname,
@@ -29,7 +27,7 @@ export const databaseConfig: DatabaseConfig = {
       database: `${appFolderName}_development`,
     }
   },
-  test: () => {
+  test: (): PG.ClientConfig => {
     const url = new URL(requireEnvVar('DATABASE_SERVER'))
     return {
       host: url.hostname,