Overview Frontend Backend CLI DevOps
The NestJS-BFF root folder contains scripts, tooling, and documentation designed to automate and simplify the operational aspects of running a NestJS-BFF application.
-
Ensure that NodeJS, Docker, and Lerna are installed on your local machine
-
Ensure you have a console installed that can run Linux shell commands. Mac can do this natively, and Cmder is an excellent option for Windows machines(and can be integrated into VS Code)
-
Navigate to the root folder of Nestjs-Bff repo, the run the following command:
# installs dependencies for all projects, symlinks local dependencies, and compiles the typescript
$ yarn bootstrap
To start the Frontend and Backend, navigate to the root folder of Nestjs-Bff repo, the run the following command:
# run backend, frontend, and a Docker hosted MongoDB instance
$ yarn start-with-docker
# if you wish to use a local installation of MongoDB instead of docker, you can use the following command instead
$ yarn start
Further details on each of the systems contained in this project can be found via the following links: