Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phoqe/brand
The missing CLI for Firebase apps.
https://github.com/phoqe/brand
apps cli firebase
Last synced: about 1 month ago
JSON representation
The missing CLI for Firebase apps.
- Host: GitHub
- URL: https://github.com/phoqe/brand
- Owner: phoqe
- License: mit
- Created: 2021-03-09T12:32:30.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-01T19:04:46.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T17:25:48.175Z (7 months ago)
- Topics: apps, cli, firebase
- Language: JavaScript
- Homepage:
- Size: 1.57 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license.md
- Codeowners: .github/codeowners
Awesome Lists containing this project
README
# brand
Brand is the missing CLI for apps using Firebase as its backend. I’ve used it for personal projects and decided to make it open-source. One useful feature is to create multiple fake accounts quickly and editing users with barely any setup.
## Installation
### Clone and develop
You can clone Brand and use it from its directory if you want to add more features specific to your needs. Simply use:
```sh
git clone https://github.com/phoqe/brand.git
```
## Setup
### Service Account
Set `GOOGLE_APPLICATION_CREDENTIAL` to the path of your Service Account Key. You can generate one in Firebase Console under Project Settings. For example:
```sh
export GOOGLE_APPLICATION_CREDENTIAL=path/to/serviceAccountKey.json
```
### Locale
You can set the default locale of Brand. The locale is used in command output and fake user data, e.g., first and last name. You can set the default locale using:
```sh
export DEFAULT_LOCALE=en
```
The locales in use by Faker, the fake user data library, can be found [here](https://github.com/Marak/Faker.js#localization).
Brand supports the following locales for command output:
- `en` (default)
- `sv`
If Brand doesn’t support the locale, it will default to `en`.
## Usage
Brand is available through `brand` in the terminal. For example:
```sh
brand --help
```
Here’s how you would disable a user with the email `[email protected]`:
```sh
brand disable [email protected]
```
You can supply an email, phone number, or UID for commands using the `id` or `ids` argument. For example, when disabling multiple users:
```sh
brand disable [email protected] +46762332652 IfqcusddgdPlsXqwiNLq9cestmo1
```
If automatic ID resolution fails, you can use the ”forcing options“ `--email` or `--phone-number`:
```sh
brand disable --email [email protected]
```
## Roadmap
- Analytics
- PDF
- Charts
- Dashboard
- Firebase-like
- Database Structure Support
- Automatic Exploration
- Advanced Email Sending
- Custom Claims
## License
MIT