init

Author: CatsMiaow

.gitattributes

@@ -1,2 +1,6 @@
 # Auto detect text files and perform LF normalization
 * text=auto
+
+# JS and TS files must always use LF for tools to work
+*.js eol=lf
+*.ts eol=lf

.gitignore

@@ -1,3 +1,9 @@
+.vscode
+.DS_Store
+dist
+build
+
+
 # Logs
 logs
 *.log
@@ -41,9 +47,6 @@ build/Release
 node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
-
 # TypeScript cache
 *.tsbuildinfo
 

.prettierrc

@@ -0,0 +1,10 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "quoteProps": "as-needed",
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "arrowParens": "always"
+}

README.md

@@ -1,2 +1,72 @@
 # node-nestjs-structure
- Node.js framework NestJS project structure
+Node.js framework NestJS project structure
+
+### Installation
+```sh
+# 1. node_modules
+$ npm i
+# 2. edit env config
+$ vim ./config/*.json
+# 3. database model entity generate
+$ npm run entity dbname
+# OR
+$ npm run entity dbname skip
+$ npm run build:entity
+```
+
+### Development
+```sh
+$ npm run start:dev
+```
+
+### Production
+```sh
+# define NODE_ENV yourself
+$ npm run build
+# OR
+$ npm start
+```
+
+### Folders
+```js
++-- bin // Custom tasks
++-- config // Env config files for `config` module
++-- dist // Source build
++-- src
+|   +-- common // Nest Module, global
+|   |   +-- controllers // Nest Controllers
+|   |   +-- decorators // Nest Decorators
+|   |   +-- dto // DTO (Data Transfer Object) Schema, Validation
+|   |   +-- filters // Nest Filters
+|   |   +-- guards // Nest Guards
+|   |   +-- interceptors // Nest Interceptors
+|   |   +-- interfaces // TypeScript Interfaces
+|   |   +-- middleware // Nest Middleware
+|   |   +-- pipes // Nest Pipes
+|   |   +-- providers // Nest Providers
+|   |   |   +-- models // or repository
+|   +-- entity // TypeORM Entities generated by `typeorm-model-generator` module
+|   +-- * // Other Nest Modules, non-global, same as common structure above
++-- test // Jest testing
++-- typings // Modules or global type definitions
+```
+
+### Implementation
+* See [app](src/app.ts), [app.module](src/app.module.ts)
+  - Database
+  - Static Files
+  - Module Router
+* [Global Authenticated Guard](src/common/guards/authenticated.guard.ts)
+* [Global Exception Filter](src/common/filters/exceptions.filter.ts)
+* [Global Logging Middleware](src/common/middleware/logger.middleware.ts)
+* [Session Login with Passport](src/base/providers/local.strategy.ts)
+* [AWS SDK Example](src/aws)
+* Controller Routes
+  - [Login](src/base/controllers/login.controller.ts)
+  - [Sample](src/sample/controllers/sample.controller.ts) Parameter, [DTO](src/sample/dto/sample.dto.ts)
+* [Database Query](src/sample/providers/database.service.ts) Sample
+
+#### Links.
+* [NestJS](https://docs.nestjs.com)
+* [Nest Sample](https://github.com/nestjs/nest/tree/master/sample)
+* [Awesome Nest](https://github.com/juliandavidmr/awesome-nestjs)

bin/entity.js

@@ -0,0 +1,49 @@
+const config = require('config');
+const fs = require('fs');
+const path = require('path');
+const rimraf = require('rimraf');
+const shell = require('shelljs');
+
+/**
+ * npm run entity dbname [skip]
+ */
+process.env.PATH += (path.delimiter + path.join(process.cwd(), 'node_modules', '.bin'));
+if (process.argv.length < 3) {
+  throw new Error('RequiredDatabase');
+};
+
+const db = process.argv[2];
+const isBuild = process.argv[3] !== 'skip';
+
+/* const DATABASE = [];
+if (!DATABASE.includes(db)) {
+  throw new Error('InvalidDatabase');
+} */
+
+const MODEL_DIR = path.join(__dirname, '../src/entity', db);
+rimraf.sync(`${MODEL_DIR}/*`);
+
+const dbConfig = config.get('db');
+shell.exec('typeorm-model-generator --noConfig --ce pascal '
+  + `-h ${dbConfig.replication.master.host} `
+  + `-p ${dbConfig.replication.master.port} `
+  + `-d ${db} `
+  + `-u ${dbConfig.replication.master.username} `
+  + `-x ${dbConfig.replication.master.password} `
+  + `-e ${dbConfig.type} `
+  + `-o ${MODEL_DIR}`);
+
+const files = [];
+fs.readdirSync(MODEL_DIR).forEach((file) => {
+  files.push(`export * from './${file.replace('.ts', '')}';`);
+});
+files.push('');
+// export entity db tables
+// AS-IS import { Tablename } from './entity/dbname/tablename';
+// TO-BE import { Tablename } from './entity/dbname';
+fs.writeFileSync(path.join(MODEL_DIR, 'index.ts'), files.join('\n'));
+
+// Build skips and builds manually when errors occur
+if (isBuild) {
+  shell.exec('npm run build:entity');
+}

config/default.json

@@ -0,0 +1,8 @@
+{
+  "aws": {
+    "access_key_id": "access_key_id",
+    "secret_access_key": "secret_access_key",
+    "region": "region"
+  },
+  "hello": "world"
+}

config/development.json

@@ -0,0 +1,26 @@
+{
+  "db": {
+    "type": "mysql",
+    "synchronize": false,
+    "logging": true,
+    "database": "dbname",
+    "replication": {
+      "master": {
+        "host": "127.0.0.1",
+        "port": 3306,
+        "username": "username",
+        "password": "password"
+      },
+      "slaves": [{
+        "host": "127.0.0.1",
+        "port": 3306,
+        "username": "username",
+        "password": "password"
+      }]
+    },
+    "extra": {
+      "connectionLimit": 10
+    }
+  },
+  "foo": "bar"
+}

config/production.json

@@ -0,0 +1,26 @@
+{
+  "db": {
+    "type": "mysql",
+    "synchronize": false,
+    "logging": false,
+    "database": "dbname",
+    "replication": {
+      "master": {
+        "host": "hostMaster",
+        "port": 3306,
+        "username": "username",
+        "password": "password"
+      },
+      "slaves": [{
+        "host": "hostSlave",
+        "port": 3306,
+        "username": "username",
+        "password": "password"
+      }]
+    },
+    "extra": {
+      "connectionLimit": 30
+    }
+  },
+  "foo": "bar"
+}