Skip to content

Yoooo this is a simple microservice app using an awesome NestJS framework

License

Notifications You must be signed in to change notification settings

nasrulfuad/mini-microservice

Repository files navigation

MIT License LinkedIn Github


Mini Microservice

An awesome microservice app using NestJS

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact
  6. Acknowledgments

About The Project

There are many resource to learn about microservice but in this project I'm trying to make a simple microservice with NestJS, so I hope you can understand how the microservice work, especially in NestJS

(back to top)

Built With

This project is built under these awesome libraries

(back to top)

Getting Started

This section is how you setup the app on your own project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Install all dependencies in every services.

  • SMTP mail credentials
  • Docker and Docker Compose

Installation

  1. Install all dependencies inside every service folders

     npm install
  2. Get a free credentials account for mail service at https://mailtrap.io

  3. Copy the credentials and put it in /mail/.env file

     # Mailer
     MAIL_HOST=smtp.mailtrap.io
     MAIL_PORT=2525
     MAIL_USERNAME=
     MAIL_PASSWORD=
     MAIL_FROM_ADDRESS="<[email protected]>"
     MAIL_FROM_NAME=${APP_NAME}
  4. Start all service with docker compose

    docker-compose up

(back to top)

Usage

To access the api, open

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nasrul - @nasrulfuad88 - [email protected]

Project Link: Mini Microservice

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

Yoooo this is a simple microservice app using an awesome NestJS framework

Resources

License

Stars

Watchers

Forks