Bacca2095 / social

Social app microservice

Description

This is a microservice for social app. It is built with the next libs:

• Nx

  • Nx is a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft.

• NestJS

  • NestJS is a framework for building efficient, reliable and scalable server-side applications. It uses modern JavaScript, is built with TypeScript and combines elements of OOP (Object Oriented Programming), FP (Functional Programming), and FRP (Functional Reactive Programming).

• Prisma

  • Prisma is a modern database access layer for TypeScript & Node.js. It replaces traditional ORMs and makes database access easy with an auto-generated query builder for TypeScript & Node.js.

• RabbitMQ

  • RabbitMQ is the most widely deployed open source message broker. It supports multiple messaging protocols. It can be used to send and receive messages, and it has been designed to be easy to use.

• MailJet

  • MailJet is an all-in-one solution to send, track and deliver transactional, notification and marketing emails. It is a cloud-based email service that allows you to send and receive email via a web-based interface or API.

Installation

$ yarn install

Project structure

├── apps                   # 🚀 NestJS apps
│   ├── api-gateway        # 🌐 Api gateway app
│   ├── auth-app           # 🔒 Auth app
│   ├── mail-app           # 📧 Mail app
│   ├── post-app           # 📝 Post app
│   └── user-app           # 🙎 User app
├── libs                   # 🤝 Shared code between apps
│   └── common             # 📦 Common code
├── docker                 # 🐳 Docker files
├── prisma                 # 🗄️ Prisma schema and migrations
└── README.md              # 📚 Project documentation

Running the app

Before running the app, you need to have a running instance of RabbitMQ, PostgreSQL and Environment Variables in .env file. You can use the following command to run the required services .

$ docker compose  -f "docker-compose.yml" up -d --build postgres rabbitmq

Migrate database schema is required before running the app.

# development
$ yarn migrate:dev

# production
$ yarn migrate:deploy

After that, you can run the app with the following command, this will generate the prisma schema for using in app.

$ yarn generate:schemas

Finally, you can run the apps with the followings commands:

# This command will run all the apps in the workspace
$ yarn run start:all

# To run an specific app use this
$ yarn start <app-name>

Where <app-name> is the name of the app to run, it can be api-gateway, auth-app, mail-app, post-app or user-app.

When the api-gateway is running, you can access the app in the browser at http://localhost:<APP_PORT>/api to see the swagger documentation.

Example:

http://localhost:3000/api

Environment Variables

The following variables must be set in the environment if the default value needs to be overridden.

For local environment use the .env. Consider that any system environment variables will take precedence.

Variable	Description	Default Value
APP_PORT	Port for the application.
DATABASE_WRITER_URL	Writer url for database
DATABASE_READER_URL	Reader url for database
MAIL_SECRET_TOKEN	MailJet secret token
MAIL_API_TOKEN	MailJet api token
MAIL_DEFAULT_SENDER	MailJet default email associated with par of keys
RABBITMQ_URL	RabbitMQ url of container

Example:

APP_PORT=3000
DATABASE_READER_URL="postgresql://prisma:docker@localhost:5432/social"
DATABASE_WRITER_URL="postgresql://prisma:docker@localhost:5432/social"
MAIL_SECRET_TOKEN=1234567890
MAIL_API_TOKEN=1234567890
MAIL_DEFAULT_SENDER="[e-mail]"
RABBITMQ_URL="amqp://guest:guest@localhost:5672"

Running in docker

docker-compose.yml file is provided to run the app in a docker container, this use the file env .docker.env to pass env variables to container is the same variables describe in Environment Variables.

To run the apps in a docker container, need build the apps and then run the container with the following commands:

# Build the apps
$ yarn build

# Run the container
$ docker compose -f "docker-compose.yml" up -d --build

Open in the browser at http://localhost:4000/api to see the swagger documentation.

If you want to change the port, you can change the docker-compose.yml file.

version: '3.8'

services:
  api-gateway:
    ports:
      - 'PORT:PORT' # Change the port here

And replace the port in the .docker.env file.

APP_PORT=PORT

Example:

# docker-compose.yml
version: '3.8'

services:
  api-gateway:
    ports:
      - '5000:5000'

# .docker.env
APP_PORT=5000

now you can access the app in the browser at http://localhost:5000/api.