Used car pricing Api

Used car pricing Api is written by NestJS RESTful API.

• Used car pricing Api
  • Installation
  • Installing Typeorm
  • Installing Validator
  • rest Clinet
    • Snippets in Visual Studio Code
  • Specifying the Runtime Environment
  • Installing the TypeORM CLI
  • Running the app
  • Test

Installation

nest new used-car-pricing-api
nest g module users
nest g module reports
nest g controller users
nest g controller reports
nest g service users
nest g service reports

Installing Typeorm

npm i @nestjs/typeorm typeorm sqlite3 

app.module.ts

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'sqlite',
      database: 'db.sqlite',
      entities: [User, Report],
      synchronize: true,
    }),
    UsersModule,
    ReportsModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})

Installing Validator

npm i class-validator class-transformer cookie-session @types/cookie-session

rest Clinet

Create file requests.http

### Create a new user
POST http://localhost:3000/auth/signup
content-type: application/json

{
  "email": "test50@test.com",
  "password": "12345"
}

shortcut for execute request in requests.http : Ctrl+Alt+R(Cmd+Alt+R for macOS) then Ctrl+Shit+p sqlite> open Database or run query in -- SQLite.sql by shortcut Ctrl+Shift+q(Cmd+Shift+q for macOS)

Snippets in Visual Studio Code

Code snippets are templates that make it easier to enter repeating code patterns, such as loops or conditional-statements. User Snippets under File > Preferences (Code > Preferences on macOS)

Specifying the Runtime Environment

npm i @nestjs/config cross-env

file: .env.development or .env.test

DB_NAME=db.sqlite
COOKIE_KEY=alskdfjlkj

file: src> app.module.ts

...
@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: `.env.${process.env.NODE_ENV}`,
    }),
    TypeOrmModule.forRootAsync({
      inject: [ConfigService],
      useFactory: (config: ConfigService) => {
        return {
          type: 'sqlite',
          database: config.get<string>('DB_NAME'),
          entities: [User, Report],
          synchronize: true,
        };
      },
    }),
    // TypeOrmModule.forRoot({
    //   type: 'sqlite',
    //   database: 'db.sqlite',
    //   entities: [User, Report],
    //   synchronize: true,
    // }),
    UsersModule,
    ReportsModule,
  ],
  controllers: [AppController],
  providers: [
    AppService,
    {
      provide: APP_PIPE,
      useValue: new ValidationPipe({
        whitelist: true,
      }),
    },
  ],
})
...

file: package.json

 "start:dev": "cross-env NODE_ENV=development nest start --watch",
 "test:e2e": "cross-env NODE_ENV=test jest --config ./test/jest-e2e.json --maxWorkers=1",

Installing the TypeORM CLI

Using CLI:

npm install ts-node --save-dev

file: package.json

"scripts": {
    ...
    // "typeorm": "cross-env NODE_ENV=development node --require ts-node/register ./node_modules/typeorm/cli.js"
    
    "typeorm": "typeorm-ts-node-commonjs",
    "migration:generate": "cross-env NODE_ENV=development npm run typeorm migration:generate -- src/db/migrations/initial-schema -d src/db/data-source.ts",
    "migration:run": "cross-env NODE_ENV=development npm run typeorm migration:run -- -d src/db/data-source.ts"
  }
}

npm run typeorm migration:generate 
npm run typeorm migration:run

Running the app

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run start:prod

Test

# unit tests
npm run test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov