Merge pull request #28 from monstar-lab-oss/yash/minor-update

Minor updates on README

Author: yashmurty

.env.template

@@ -5,6 +5,6 @@ DB_PORT=
 DB_NAME=
 DB_USER=
 DB_PASS=
-JWT_EXPIRES_IN=15m
+JWT_EXPIRES_IN_SECONDS=3600
 JWT_PUBLIC_KEY=
 JWT_PRIVATE_KEY=

README.md

@@ -11,6 +11,19 @@ This is a Github Template Repository, so it can be easily [used as a starter tem
 
 To view sample implementations based on this starter-kit, please visit the [nestjs-sample-solutions](https://github.com/monstar-lab-oss/nestjs-sample-solutions) repository.
 
+## Starter-kit Features
+
+| Feature                  | Info            | Progress |
+| ------------------------ | --------------- | -------- |
+| Authentication           | JWT             | Done     |
+| ORM Integration          | TypeORM         | Done     |
+| DB Migrations            | TypeORM         | Done     |
+| Logging                  | nestjs-pino     | Done     |
+| Request Validation       | class-validator | Done     |
+| Docker Ready             | Dockerfile      | Done     |
+| Auto-generated OpenAPI   | -               | Done     |
+| Auto-generated ChangeLog | -               | WIP      |
+
 ## Installation
 
 ```bash

docker-compose.yml

@@ -1,4 +1,4 @@
-version: "3.8"
+version: '3.8'
 
 services:
   app:
@@ -15,16 +15,18 @@ services:
     environment:
       APP_ENV: ${APP_ENV}
       APP_PORT: ${APP_PORT}
-      DB_HOST: ${DB_HOST}
+      DB_HOST: mysqldb
       DB_PORT: ${DB_PORT}
       DB_NAME: ${DB_NAME}
       DB_USER: ${DB_USER}
       DB_PASS: ${DB_PASS}
-      JWT_EXPIRES_IN: ${JWT_EXPIRES_IN}
+      JWT_EXPIRES_IN_SECONDS: ${JWT_EXPIRES_IN_SECONDS}
       JWT_PUBLIC_KEY: ${JWT_PUBLIC_KEY}
       JWT_PRIVATE_KEY: ${JWT_PRIVATE_KEY}
+    depends_on:
+      - mysqldb
 
-  db:
+  mysqldb:
     image: mysql:8
     command: --default-authentication-plugin=mysql_native_password
     ports:
@@ -39,6 +41,8 @@ services:
     image: adminer
     ports:
       - 8080:8080
+    depends_on:
+      - mysqldb
 
 volumes:
   node_modules:

ormconfig.js

@@ -5,7 +5,7 @@ module.exports = {
   username: process.env.DB_USER,
   password: process.env.DB_PASS,
   database: process.env.DB_NAME,
-  entities: [__dirname + '/**/**/*.entity{.ts,.js}'],
+  entities: [__dirname + '/src/**/*.entity{.ts,.js}'],
   migrations: [__dirname + '/migrations/**/*{.ts,.js}'],
   migrationsRun: false,
   cli: {

src/auth/auth.module.ts

@@ -22,7 +22,7 @@ import { JwtStrategy } from './strategies/jwt.strategy';
         publicKey: configService.get<string>('jwt.publicKey'),
         privateKey: configService.get<string>('jwt.privateKey'),
         signOptions: {
-          expiresIn: configService.get<number>('jwt.expiresIn'),
+          expiresIn: configService.get<number>('jwt.expiresInSeconds'),
           algorithm: 'RS256',
         },
       }),

src/shared/config/configuration.ts

@@ -13,6 +13,6 @@ export default (): any => ({
   jwt: {
     publicKey: readFileSync(process.env.JWT_PUBLIC_KEY, 'utf8'),
     privateKey: readFileSync(process.env.JWT_PRIVATE_KEY, 'utf8'),
-    expiresIn: parseInt(process.env.JWT_EXPIRES_IN, 10),
+    expiresInSeconds: parseInt(process.env.JWT_EXPIRES_IN_SECONDS, 10),
   },
 });

src/shared/config/module-options.ts

@@ -17,6 +17,6 @@ export const configModuleOptions: ConfigModuleOptions = {
     DB_PASS: Joi.string().required(),
     JWT_PUBLIC_KEY: Joi.string().required(),
     JWT_PRIVATE_KEY: Joi.string().required(),
-    JWT_EXPIRES_IN: Joi.number().required(),
+    JWT_EXPIRES_IN_SECONDS: Joi.number().required(),
   }),
 };