This is a monorepo for the Nx toolkits. It contains the following toolkits:
- @nx-toolkits/firebase - Generate Firebase Functions apps.
- @nx-toolkits/testing-library - Setup Testing Library for React and Angular.
This is a toolkit for generating Firebase apps - at the moment, only Firebase Functions apps are supported, but I am working on expanding it to include Firebase hosting.
We generate a Firebase Functions app using the @nx-toolkits/firebase:functions and
connect it to the Firebase project using the --project option. This allows for
normal firebase cli commands to be used to work, as if it was an app generated
using firebase cli.
Install the generator in an nx workspace:
npm install -D @nx-toolkits/firebaseUse the generator to generate a Firebase Functions app:
nx g @nx-toolkits/firebase:functionsThis will generate a Firebase Functions app in the apps folder.
| Option | alias | Description |
|---|---|---|
--name |
The name of the nx app to create. | |
--firebaseProject |
--project |
The Firebase project to connect to. |
--codebase |
The codebase to use. Learn more here about Firebase Codebase | |
--nodeVersion |
The runtime node version to use on firebase functions. | |
--directory |
The directory to create the app in. | |
--tags |
Tags to add to the app. | |
--dry-run |
Run through without making changes. |
You can deploy a Firebase Functions app using the nx run deploy command:
nx run my-functions-app:deployThe above with run linting, building, and then deploy the app to Firebase.
You can also use firebase-tools to deploy the app:
firebase deploy --only functionsYou can lint a Firebase Functions app using the nx run lint command:
nx run my-functions-app:lintYou can build a Firebase Functions app using the nx run build command:
nx run my-functions-app:build- Add support for Firebase functions
- Add support for Firebase hosting