Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahrnee/nestjs-bff

A full-stack TypeScript solution, and starter project. Includes an API, CLI, and example client webapp. Features include production grade logging, authorization, authentication, MongoDB migrations, and end-to-end testing.
https://github.com/ahrnee/nestjs-bff

angular bff boilerplate fullstack lerna nestjs nestjs-bff nodejs template typescript webapp

Last synced: 3 months ago
JSON representation

A full-stack TypeScript solution, and starter project. Includes an API, CLI, and example client webapp. Features include production grade logging, authorization, authentication, MongoDB migrations, and end-to-end testing.

Awesome Lists containing this project

README 

        
# Nestjs-BFF OVERVIEW





  Overview

     

	Frontend

     

	Backend

     

	CLI

     

	DevOps




## Status

This library is currently 'on ice' and is no longer being activley maintained at this time. However, it may still server as a useful as a reference to others on how to build a production ready app around the NestJS platform. Also, it is anticiapted that at some indeterminate point in the fututure, the library will be thawed, updated, and work will continue.



If anyone is interested in taking a leading role in the maintenance and update of this library, please contact me to dicsuss.



## Overview



NestJS-BFF is a full-stack TypeScript solution, and starter project. It is intended for developers who are looking to fast-track building a strongly typed, enterprise-grade, modern NodeJs application, with supporting tooling.



This implementation uses the [BFF](https://samnewman.io/patterns/architectural/bff/) pattern, leveraging [NestJS](https://nestjs.com/) as the primary framework for the backend. The frontend example is in [Angular](https://angular.io/), although any client-side Javascript framework can easily be used, including [React](https://reactjs.org/), or [Vue](https://vuejs.org/) js.



## Contents



This is a Mono-repo project containing a [Backend](backend/README.md), companion [CLI](cli/README.md), [Frontend](frontend/README.md), and companion NPM packages. Follow the README navigation links for details on each of these. The core infrastructure is contained in NPM packages, so that projects build using this boilerplate can easily benefit from future updates though a simple NPM update command.



## Installation & Usage



See the [DevOps](DEVOPS.md) documentation and folder for instructions and scripts to install, run, and maintain nestjs-bff applications



## Key Features



- **Strongly Typed** backend, leveraging the power of [TypeScript](https://www.typescriptlang.org/), [NestJS](https://nestjs.com/) and [Express](https://expressjs.com/)

- **DDD style layered architecture** with Application Services and composable Domain objects

- **Comprehensive authentication and authorization system** in-the-box

- **JWT Authentication** for robust and flexible security

- **Social Login** with Facebook (complete), Google, and Twitter (under development), using the more secure [Authorization Code Grant](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/) flow

- **Secured-by-default** with 'allow list' approach

- **Flexible Caching** leveraging the powerful [cache-manager](https://www.npmjs.com/package/cache-manager) library

- **Repository Pattern** in-the-box for simple data-access

- **MongoDB Migrations** for easy database seeding and management

- **Winston and Console Logger Service** in-the-box

- **Configuration pattern** simple and strongly types

- **e2e Testing** pattern leveraging [Jest](https://jestjs.io/)



## Structure



- Frontend **Frontend Layer** example, built with Angular

- Global **Global Layer** layer that can be shared between the backend and the frontend

- Backend **Hosting Layer** for exposing Application and Domain Services over a multiple transports

- Backend **Application Services Layer** for composing Domain Services

- Backend **Domain Services Layer** for encapsulating core domain logic

- Backend **Infrastructure Layer** packages, for building and supporting the layered architecture



## Architecture Overview



![NestJS-BFF Architecture Overview](docs/images/NestJS-BFF-ArchitectureOverview.png 'NestJS-BFF Architecture Overview')



## Developer Benefits



There are a number of benefits that make NestJs and Angular a very compelling web development stack:



- Core technologies [NestJS](https://nestjs.com/) and [Angular](https://angular.io/) are both versatile and highly compatible frameworks, that provide a great developer experience

- Consistent technology and development patterns for both frontend and backend development

  - Results in significant increase in development efficiency

  - TypeScript language for both the backend and frontend

  - Strongly type on both the backend and frontend

  - Leverages the Node JavaScript framework for both backend and frontend development

  - Incredibly similar architecture and design patterns

- Backend framework can be leveraged for other execution contexts, including CLI (example included) or even Desktop

- Leverages fully open source technology

- Hosting options are broad, and flexible, with multiple value-options, and broad native cloud hosting support (including Heroku)



## Background



[NestJS](https://nestjs.com/) is a fantastic project, and a pleasure to develop with. However, it is a framework by design, and not a complete production-ready web-application solution. Features such as logging, configuration management, data-base migrations, and even authentication need to be learned, assembled, and configured before they can be used.



This project aims to provide an enterprise-ready web-application skeleton, out-of-the-box, and built on top of the nest-js framework.



# Notes



- The Backend can run independently from the CLI

- The CLI requires the Backend to compile and run

- The Frontend can run independently, but requires the Backend to be running to complete requests, including for authentication



# Contributions



Contributions are not only welcome, but encouraged. Please help make this better! See the [Contributions Guide](CONTRIBUTIONS.md) for details.



# Attributions



See the [Attributions](docs/ATTRIBUTIONS.md) section.



## Companion Libraries



This library is part of a collection of companion tools and libraries under the [AbleStack](https://github.com/ablestack) umbrella. All of these libraries share the common goal:



> Helping small teams and solo-developers build big ideas rapidly and affordably



To achieve these goals, the following principles are applied:



- Selectively **leverage existing open source tools and libraries**, where, high quality, open source tools and libraries where possible

  - Curate usage examples, and guidance where available, and create where not available

- Prioritize technology choices that **embrace open source**

  - PostgreSQL over MSSQL is an example of this

- **Avoid** technology choices that could result in **hosting vendor lock-in**

  - ApolloGraphQL over AWS Amplify is an example of this

- **Automate wherever possible**, from development, through testing, to deployment, monitoring, and maintenance

  - Codegen from strongly types schemas is a good example of this.

- Where needed, **develop high quality, open source tools and libraries** to augment and automate existing open source tooling and libraries



## Readme Navigation



Further details on each of the systems contained in this project can be found via the following links:



- _[Overview](README.md)_

- [Frontend](frontend/README.md)

- [Backend](backend/README.md)

- [CLI](cli/README.md)

- [DevOps](DEVOPS.md)