dev setup

.dockerignore

@@ -0,0 +1,18 @@
+Dockerfile
+.dockerignore
+node_modules
+npm-debug.log
+README.md
+.git
+.gitignore
+.linterstagedrc.json
+jest.config.js
+.husky
+dist
+.vscode
+test
+
+conf/.env
+conf/.env.keys
+conf/.example.secrets.env
+conf/.example.env

.swcrc

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "sourceMaps": true,
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "decorators": true,
+      "dynamicImport": true
+    },
+    "transform": {
+      "legacyDecorator": true,
+      "decoratorMetadata": true
+    },
+    "baseUrl": "./"
+  },
+  "minify": false
+}

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to API",
+      "address": "localhost",
+      "port": 9229,
+      "localRoot": "${workspaceFolder}",
+      "remoteRoot": "/app",
+      "trace": true,
+      "restart": true,
+      "sourceMaps": true,
+      "skipFiles": ["<node_internals>/**"]
+    }
+  ]
+}

Dockerfile

@@ -0,0 +1,23 @@
+FROM node:20-alpine as base
+# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
+RUN apk update && apk add --no-cache libc6-compat
+WORKDIR /app
+EXPOSE 3000
+
+# Rebuild the source code only when needed
+FROM base as deps
+RUN apk add --no-cache make && apk add --no-cache bash
+COPY . .
+RUN npm ci
+
+FROM deps as prod
+RUN make build
+RUN addgroup --system --gid 1001 nodejs
+RUN adduser --system --uid 1001 prod-nodejs
+USER prod-nodejs
+CMD ["make", "start.prod"]
+
+FROM deps as dev
+EXPOSE 9229
+RUN make build
+CMD ["make", "start.debug.open"]

Makefile

@@ -4,7 +4,7 @@ SHELL := /bin/bash
 
 .PHONY: init build clear lint typecheck test pre-commit pre-push migrate up up-all list funding fuel report profiles recover decrypt encrypt
 
-all: init clean typecheck test
+all: init clean typecheck
 
 init:; npm i
 
@@ -22,7 +22,7 @@ test.cov :; npx jest --passWithNoTests --coverage
 
 test.debug :; node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand
 
-test.e2e: npx jest --config ./test/jest-e2e.json
+test.e2e:; npx jest --config ./test/jest-e2e.json
 
 pre-commit: typecheck lint-stg
 
@@ -38,6 +38,8 @@ start.dev:; npx nest start --watch
 
 start.debug:; npx nest start --debug --watch
 
+start.debug.open:; npx nest start --debug 0.0.0.0 --watch
+
 start.prod:; node dist/main
 
 -include ${FCT_PLUGIN_PATH}/makefile-external

README.md

@@ -1,35 +1,37 @@
 # web3-glue
 
+Development starter kit for web3 node.js apps with nestjs & viem
+
 ## Installation
 
 ```bash
-npm install
+make
 ```
 
 ## Running the app
 
 ```bash
 # development
-$ npm run start
+$ make start
 
 # watch mode
-$ npm run start:dev
+$ make start.dev
 
 # production mode
-$ npm run start:prod
+$ make start.prod
 ```
 
 ## Test
 
 ```bash
 # unit tests
-$ npm run test
+$ make test
 
 # e2e tests
-$ npm run test:e2e
+$ make test.e2e
 
 # test coverage
-$ npm run test:cov
+$ make test.cov
 ```
 
 ## License

docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3.7'
+
+services:
+  nest-app-develop:
+    hostname: nest-app-develop
+    image: nest-app-develop
+    restart: always
+    build:
+      context: .
+      target: dev
+    ports:
+      - 3000:3000
+      - 9229:9229
+    volumes:
+      - ./src:/app/src:cached

nest-cli.json

@@ -3,6 +3,7 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
-    "deleteOutDir": true
+    "deleteOutDir": true,
+    "builder": "swc"
   }
 }