Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mainawycliffe/nx-toolkits
An NX Generator For Firebase Functions and Hosting
https://github.com/mainawycliffe/nx-toolkits
firebase firebase-functions firebase-hosting firestore javascript monorepo nx nx-cloud nx-plugin nx-workspace serverless testing typescript
Last synced: about 2 months ago
JSON representation
An NX Generator For Firebase Functions and Hosting
- Host: GitHub
- URL: https://github.com/mainawycliffe/nx-toolkits
- Owner: mainawycliffe
- License: mit
- Created: 2022-12-24T12:25:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T22:22:42.000Z (9 months ago)
- Last Synced: 2024-05-01T19:31:42.589Z (8 months ago)
- Topics: firebase, firebase-functions, firebase-hosting, firestore, javascript, monorepo, nx, nx-cloud, nx-plugin, nx-workspace, serverless, testing, typescript
- Language: TypeScript
- Homepage:
- Size: 1.47 MB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Nx Toolkits
This is a monorepo for the Nx toolkits. It contains the following toolkits:
- [@nx-toolkits/firebase](packages/firebase/README.md) - Generate Firebase
Functions apps.
- [@nx-toolkits/testing-library](packages/testing-library/README.md) - Setup
Testing Library for React and Angular.
## @nx-toolkits/firebase
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.
### NX Functions Generator
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.
#### Installation
Install the generator in an nx workspace:
```bash
npm install -D @nx-toolkits/firebase
```
#### Generate a Firebase Functions app
Use the generator to generate a Firebase Functions app:
```bash
nx g @nx-toolkits/firebase:functions
```
This will generate a Firebase Functions app in the `apps` folder.
#### Generator Options
| 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](https://firebase.googlecom/docs/functions/organize-functions) 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. |
#### Deploy a Firebase Functions app
You can deploy a Firebase Functions app using the `nx run deploy` command:
```bash
nx run my-functions-app:deploy
```
The above with run linting, building, and then deploy the app to Firebase.
You can also use firebase-tools to deploy the app:
```bash
firebase deploy --only functions
```
#### Linting a Firebase Functions app
You can lint a Firebase Functions app using the `nx run lint` command:
```bash
nx run my-functions-app:lint
```
#### Building a Firebase Functions app
You can build a Firebase Functions app using the `nx run build` command:
```bash
nx run my-functions-app:build
```
### Roadmap
- [x] Add support for Firebase functions
- [ ] Add support for Firebase hosting