Skip to content

Latest commit

 

History

History

04-grpc

README.md

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Donate us Support us Follow us on Twitter

Description

Basic gRPC application recipe for Mau.

Project setup

  1. Install necessary dependencies
$ npm install
$ npm install -g @nestjs/mau
  1. Create a new Mau project.
  2. Within that project, create 2 applications: HTTP client and gRPC server.
  3. For the gRPC application, you will need to validate the domain as AWS requires gRPC apps to use HTTPS.
  4. Update your domain's DNS settings to point to the AWS load balancer (e.g., CNAME record).
  5. Generate API keys for both applications.
  6. Run the following commands to deploy each application to the cloud:
$ npm run build APP_NAME
$ mau deploy APP_NAME

Environment variables

"Client" application

GRPC_SERVER_URL=YOUR_DOMAIN:YOUR_PORT

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Resources

Check out a few resources that may come in handy when working with NestJS:

  • Visit the NestJS Documentation to learn more about the framework.
  • For questions and support, please visit our Discord channel.
  • To dive deeper and get more hands-on experience, check out our official video courses.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • Need help with your project (part-time to full-time)? Check out our official enterprise support.
  • To stay in the loop and get updates, follow us on X and LinkedIn.
  • Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.