feat(version): read app info from package.json (#174)

* package.json: follow npm Docs guidelines

https://docs.npmjs.com/cli/v8/configuring-npm/package-json#people-fields-author-contributors

* app.config.ts: read more stuff from package.json

The package `read-pkg` allows for it, let's use it :)

* package.json: fix author URL

* fix tsc errors

* fix(appinfo): ran prettier

* Update .env

Co-authored-by: Borja Paz Rodríguez <[email protected]>

Author: Avinash Reddy

.env

@@ -1,10 +1,19 @@
 ## App configuration ##
 NODE_ENV=development
-APP_NAME=base-app
 PORT=5000
 
+## App information overrides ##
+# By default, these are read from package.json #
+#APP_VERSION=
+APP_NAME=ets-api
+#APP_DESCRIPTION=
+#AUTHOR_NAME=
+#AUTHOR_EMAIL=
+#AUTHOR_WEBSITE=
+
 ## Docker configuration ##
 # App configuration #
+IMAGE_NAME=express-typescript-skeleton
 EXTERNAL_PORT=5000
 LOGS_VOLUME=../.docker/app/logs
 

docker/docker-compose.dev.yml

@@ -8,8 +8,8 @@ services:
         - PORT=${PORT}
       dockerfile: ./docker/Dockerfile
       target: dev
-    image: ${APP_NAME}:dev
-    container_name: ${APP_NAME}
+    image: ${IMAGE_NAME}:dev
+    container_name: ${IMAGE_NAME}
     restart: always
     depends_on:
       - db
@@ -52,4 +52,4 @@ volumes:
 
 networks:
   default:
-    name: ${APP_NAME}-network
+    name: ${IMAGE_NAME}-network

docker/docker-compose.prod.yml

@@ -8,8 +8,8 @@ services:
         - PORT=${PORT}
       dockerfile: ./docker/Dockerfile
       target: prod
-    image: ${APP_NAME}:prod
-    container_name: ${APP_NAME}
+    image: ${IMAGE_NAME}:prod
+    container_name: ${IMAGE_NAME}
     restart: always
     depends_on:
       - db
@@ -38,4 +38,4 @@ services:
 
 networks:
   default:
-    name: ${APP_NAME}-network
+    name: ${IMAGE_NAME}-network

package.json

@@ -1,8 +1,12 @@
 {
-  "name": "node-ts-skeleton",
+  "name": "express-typescript-skeleton",
   "version": "1.3.3",
-  "description": "This is a template to start developing a REST API with Node.js (Express), TypeScript, Eslint, Prettier, Husky, etc.",
-  "author": "Borja Paz Rodríguez (@borjapazr)",
+  "description": "🔰🦸 Template to start developing a REST API with Node.js (Express), TypeScript, ESLint, Prettier, Husky, Prisma, etc.",
+  "author": {
+    "name": "Borja Paz Rodríguez",
+    "email": "[email protected]",
+    "url": "https://bpaz.dev"
+  },
   "license": "MIT",
   "keywords": [
     "node",

src/presentation/config/app.config.ts

@@ -4,11 +4,11 @@ import { getEnvironmentNumber, getEnvironmentString } from '@infrastructure/shar
 
 const AppInfo = {
   APP_VERSION: getEnvironmentString('APP_VERSION', readPackageJsonSync().version),
-  APP_NAME: getEnvironmentString('APP_NAME', 'base-app'),
-  APP_DESCRIPTION: getEnvironmentString('APP_DESCRIPTION', '🚀 To infinity and beyond!'),
-  AUTHOR_NAME: getEnvironmentString('AUTHOR_NAME', 'Borja Paz Rodríguez'),
-  AUTHOR_EMAIL: getEnvironmentString('AUTHOR_EMAIL', '[email protected]'),
-  AUTHOR_WEBSITE: getEnvironmentString('AUTHOR_WEBSITE', 'https://bpaz.dev')
+  APP_NAME: getEnvironmentString('APP_NAME', readPackageJsonSync().name),
+  APP_DESCRIPTION: getEnvironmentString('APP_DESCRIPTION', readPackageJsonSync().description || 'N/A'),
+  AUTHOR_NAME: getEnvironmentString('AUTHOR_NAME', readPackageJsonSync().author?.name || 'N/A'),
+  AUTHOR_EMAIL: getEnvironmentString('AUTHOR_EMAIL', readPackageJsonSync().author?.email || 'N/A'),
+  AUTHOR_WEBSITE: getEnvironmentString('AUTHOR_WEBSITE', readPackageJsonSync().author?.url || 'N/A')
 };
 
 const AppConfig = {