Room Server

Structure

graph TD;
        Database-->Application;
        Actuator-->Application;
        Automation-->Application;
        Fusion-->Application;
        Grpc-->Application;
        Node-->Application;
        User-->Application;
        Unit-->Application;
        Developer-->Application;
        Attachment-->Database;
        Dashboard-->Database;
        Datasheet-->Database;
        Form-->Database;
        Mirror-->Database;
        Resource-->Database;
        Shared-->Attachment;
        Shared-->Dashboard;
        Shared-->Datasheet;
        Shared-->Form;
        Shared-->Mirror;
        Shared-->Resource;
        Shared-->Database;
        Shared-->Actuator;
        Shared-->Automation;
        Shared-->Fusion;
        Shared-->Grpc;
        Shared-->Node;
        Shared-->User;
        Shared-->Unit;
        Shared-->Developer;

shared module is a shared and global module that other modules depend on in default.

Description

TypeScript server project based on Nest framework

Learning Materials

• awesome-nestjs

Dependencies

• mysql mysql client
• typeorm database object storage framework
• redis redis client
• redis-lock redis key lock
• rxjs JavaScript responsive programming
• socket.io-client socket.io for nodejs client
• socket.io-redis socket.io for redis client
• class-transformer JSON to object, used with reflect-metadata
• class-validator validation framework
• rimraf The UNIX command rm -rf for nodejs
• winston log framework for nodejs

Installation

yarn install

Running the app

# basic mode
$ yarn start

# watch mode
$ yarn start:dev

# debug/watch mode
$ yarn start:debug

# production mode, remember to execute `yarn build` before running
$ yarn start:prod

Test

# you can use `pnpm` or `npx`, the examples below use `pnpm`.
# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Environment variables

See env/.env.defaults for more details

Define local variables for local development

You can create a .env.development.local file in the env folder to define environment variables for local development. This file is typically ignored by Git, so you can use it to store sensitive or environment-specific information that you don't want to commit to your repository.

If a variable is defined in both the .env.development.local file and the .env.defaults file, the value in the .env.development.local file will take precedence. This allows you to override the default values for certain variables when developing locally, while still maintaining a set of default values that can be used in other environments.

Deployment environment:

process.env.NODE_ENV enum: 'development' | 'production'

backend-server(JAVA) service api address

process.env.BACKEND_BASE_URL default: http://localhost:8081/api/v1/

redis configuration

redis host process.env.REDIS_HOST

redis port process.env.REDIS_PORT

redis password process.env.REDIS_PASSWORD

redis db process.env.REDIS_DB

Service exposed port

process.env.PORT default: 3333

Logging Framework

• winston
• bunyan
• log4js
• nestjs-Logger