note

Note

This microservice is written in Go and implements a gRPC service, utilizing gRPC Gateway for HTTP/REST endpoint compatibility and Swagger for API documentation. It also integrates with MongoDB for data storage and Docker for easy deployment.

Run

Docker

1. You must have Docker installed.
2. Now in the main folder of the project you need to create an .env file in which you need to configure to add the following environment variables.

   NOTE_ACCESS_TOKEN_SECRET=
   
   NOTE_MONGODB_HOST=
   NOTE_MONGODB_PORT=
   NOTE_MONGODB_USERNAME=
   NOTE_MONGODB_PASSWORD=
   NOTE_MONGODB_DATABASE=
   

3. Now run the following commands to build and run the Docker container.

   docker build --tag note .
   docker run --publish 8082:8082 --publish 8092:8092 --name note --detach --restart always --env-file ./.env note
   

Docker Compose

1. You must have Docker and Docker Compose installed.
2. Now in the main folder of the project you need to create an .env file in which you need to configure to add the following environment variables.

   NOTE_ACCESS_TOKEN_SECRET=
   
   NOTE_MONGODB_HOST=
   NOTE_MONGODB_PORT=
   NOTE_MONGODB_USERNAME=
   NOTE_MONGODB_PASSWORD=
   NOTE_MONGODB_DATABASE=
   

3. Now you need to run the following command.

   docker-compose up --detach --build --remove-orphans
   

Development

Prerequisites

• GoLand or Visual Studio Code
• Go
• Protocol Buffer Compiler

Dependencies

make dependencies

Other

Protocol Buffer

• Code generation.

  make protobuf
  

• Plugins install.

  make protoplugins
  

• Plugins.

  • protoc-gen-validate
  • gRPC-Gateway

Swagger

make swagger

Environment variables

NOTE_ACCESS_TOKEN_SECRET=

NOTE_MONGODB_HOST=
NOTE_MONGODB_PORT=
NOTE_MONGODB_USERNAME=
NOTE_MONGODB_PASSWORD=
NOTE_MONGODB_DATABASE=