// readme

BFF (Backend For Frontend)

Backend for frontend is a series of backend services and libraries that enhance user experience for the frontend.

Getting Started

Install dependencies:

yarn

Create the .env file:

# If you are not using docker
cp .env.example .env

# If you are using docker (handy to launch a service directly using NX)
cp .env.example .env.docker

Start docker:

yarn compose:up

Develop

Notification Producer

See the local notification stack guide. It covers the producer, Telegram consumer, required services, environment variables, migrations, and verification without requiring the API or USD-price services.

Create a new service or library

To add a new app or library, you can run the following command;

# New API
yarn new:fastify

# New Library
yarn new:lib

# New Node app
yarn new:node

For APIs and apps, it will create a Dockerfile. Please, remember to update:

  • The docker-compose.yml file to include the new service.
  • The github actions to include the new service (.github/workflows/ci.yml)

For more info, see:…