Forem: mkop

How To Build Autocomplete search with Nestjs, Elasticsearch and Vue

mkop — Sun, 09 Aug 2020 06:09:01 +0000

In this Post, we will cover

create and build docker images
create and setup Nest app
configure Elasticsearch with Nest app
create and setup Vue app

let's start

Project root directory structure:

.
├── client
├── server
└── dev.yml

1. Setup Nest and Elasticsearch

Server directory structure:

.
├── src
│   ├── config
│   │   ├── config.module.ts
│   │   └── config.service.ts
│   ├── modules
│   │   ├── movie
│   │   │   ├── movie.controller.ts
│   │   │   ├── movie.module.ts
│   │   │   └── movie.service.ts
│   │   └── search
│   │       ├── search.module.ts
│   │       └── search.service.ts
│   ├── app.controller.ts
│   ├── app.module.ts
│   ├── main.ts
│   └── typings.d.ts
├── Dockerfile
├── .env
├── movies.json
├── package.json
└── tslint.json

ConfigModule and ConfigService

in the ConfigModule we have to import env variables in project

config.module.ts
config.service.ts
SearchModule and SearchService

in the SearchModule we have to configure Elasticsearch and fill movie-index with data from movies.json

movie-indexautomatically created when you start a project.

search.module.ts
search.service.ts
MovieModule, MovieService and MovieController

we create MovieController, MovieService and import SearchModule for access method search in SearchService

movie.module.ts
movie.controller.ts
movie.service.ts
AppModule

in this step we will create healthcheck endpoint in AppController for docker health.
we have to import MovieModule, ConfigModule and SearchModule into AppModule

app.module.ts
app.controller.ts
main.ts
create server/Dockerfile

docker image for Nest app

FROM node:13
WORKDIR /app/server
COPY package*.json ./
RUN npm install
COPY . .
RUN npm run build
EXPOSE 3000/tcp
CMD [ "node", "dist/main.js" ]

Create .env file in server directory

#App
APP_ENV=dev
GLOBAL_PREFIX=api
#Elastic
ELASTICSEARCH_NODE=http://dockerip:9200
NODE_PORT=3000
ELASTICSEARCH_INDEX=movies-index

how to find elastic url in docker:

docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' nest-elasticsearch

Replace the given dockerIp with ELASTICSEARCH_NODE=http://dockerIp:9200 in .env

2. Setup Vue app

Client directory structure:

.
├── Dockerfile
├── package.json
├── public
│   └── index.html
└── src
    ├── App.vue
    ├── asset
    ├── components
    │   └── Home.vue
    ├── main.js
    ├── plugins
    │   └── boostrap-vue.js
    └── router.js

App.vue

<router-view> The component is a functional component that renders the matched component for the given path. Components rendered in <router-view> can also contain their own <router-view>, which will render components for nested paths.

Home.vue

boostrap-vue.js

setup boostrap with vue

main.js

router.js
create client/Dockerfile

docker for Vue app

FROM node:11.1-alpine as develop-stage
WORKDIR /app/client
COPY package*.json ./
RUN npm install
COPY . .
FROM develop-stage as build-stage
RUN npm run build
COPY --from=build-stage /app/client/dist /usr/share/nginx/html
EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]

3. Setup Docker for project

why use Docker?

Docker is a tool designed to make it easy to create, deploy and run application by using containers.

install docker
create dev.yml

Check out the full project on GitHub

That's it!

Feel free to ask questions, make comments or suggestions, or just say hello in the comments below.

Library for Http errors in Typescript

mkop — Fri, 13 Mar 2020 09:39:35 +0000

HTTP errors response

This library provide some Error response classes to map the problems that you may want to report to your clients.

Usage



npm install http-errors-response-ts --save

Usage

import error response from lib



import { BadRequestResponse } from 'http-errors-response-ts';

throw new BadRequestResponse();

expexted object



{

  "statusCode": 400,

  "message": "Bad Request"

}

with custom message



import { BadRequestResponse } from 'http-errors-response-ts';

throw new BadRequestResponse('Custom message');

expexted object



{

  "statusCode": 400,

  "message": "Custom message"

}

List of all Error

Status Code	Error Name
400	BadRequestResponse
401	UnauthorizedResponse
402	PaymentRequiredResponse
403	ForbiddenResponse
404	NotFoundResponse
405	MethodNotAllowedResponse
406	NotAcceptableResponse
407	ProxyAuthenticationRequiredResponse
408	RequestTimeoutResponse
409	ConflictResponse
410	GoneResponse
411	LengthRequiredResponse
412	PreconditionFailedResponse
413	PayloadTooLargeResponse
414	URITooLongResponse
415	UnsupportedMediaTypeResponse
416	RangeNotSatisfiableResponse
417	ExpectationFailedResponse
418	ImATeapotResponse
421	MisdirectedRequestResponse
422	UnprocessableEntityResponse
423	LockedResponse
424	FailedDependencyResponse
425	UnorderedCollectionResponse
426	UpgradeRequiredResponse
428	PreconditionRequiredResponse
429	TooManyRequestsResponse
431	RequestHeaderFieldsTooLargeResponse
451	UnavailableForLegalReasonsResponse
500	InternalServerErrorResponse
501	NotImplementedResponse
502	BadGatewayResponse
503	ServiceUnavailableResponse
504	GatewayTimeoutResponse
505	HTTPVersionNotSupportedResponse
506	VariantAlsoNegotiatesResponse
507	InsufficientStorageResponse
508	LoopDetectedResponse
509	BandwidthLimitExceededResponse
510	NotExtendedResponse
511	NetworkAuthenticationRequiredResponse

That's it!

npm package

Feel free to ask questions, make comments or suggestions, or just say hello in the comments below.

How to Use Serverless with NestJS

mkop — Sun, 23 Feb 2020 11:14:16 +0000

Need an example of how to get started with NestJS and Serverless framework?

NestJS is a back-end framework for creating scalable applications.

Getting Started

NestJS

To start playing with NestJS you should have node (version >= 8.9.0) and npm installed. You can download and install Node from the official website.

Create a database automatically

docker run --name mysql57 -p 3306:3306 \
-e MYSQL_ROOT_PASSWORD=superpassword \
-e MYSQL_USER=user \
-e MYSQL_PASSWORD=pass \
-e MYSQL_DATABASE=mydb \
-d mysql/mysql-server:5.7

Serverless framework

For serverless you need to install the required package globally:

npm install serverless -g

To follow this tutorial, you are going to need clone repository NestJS-Serverless-TypeOrm

Now just start application:

npm run sls:offline

Let's create the first author in the application

You can try crud operations on Author

That's it!

Feel free to ask questions, make comments or suggestions, or just say hello in the comments below.