Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osfunapps/os-firebase-project-creator-npm
This is a self contained automation module for creating an ios/android app in Firebase and downloading the json file
https://github.com/osfunapps/os-firebase-project-creator-npm
firebase helper javascript module nodejs npm
Last synced: 27 days ago
JSON representation
This is a self contained automation module for creating an ios/android app in Firebase and downloading the json file
- Host: GitHub
- URL: https://github.com/osfunapps/os-firebase-project-creator-npm
- Owner: osfunapps
- Created: 2019-06-27T07:23:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-07T14:36:42.000Z (almost 4 years ago)
- Last Synced: 2024-11-01T09:12:03.754Z (about 2 months ago)
- Topics: firebase, helper, javascript, module, nodejs, npm
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Introduction
------------
This project will register a new app to an existing Firebase project and save the Google Services file in a desired path.
## Installation
Install via npm:
npm i os-firebase-project-creator
## Usage
Require:
```js
var pc = require("os-firebase-project-creator")
```
# Register an Android app:
```js
/**
* Will register a new Android app to a given Firbase project
*
* @param projectName your project name
* @param packageName your app's package name
* @param appNickname the name which be displayed in the project
* @param jsonFilePath the path to save the json file
* @param puppeteerPage (optional) puppeteer page to use (if not specified, will create a new one)
* @param fireFoxNightlyPath the path to your FireFox Nightly runner file
* In Windows that's usually your firefox.exe file (like 'C:/Program Files/Firefox Nightly/firefox.exe').
* In Mac that's usually your firefox file, located in your Firefox Nightly.app, inside the Applications dir
* @param killBrowserAtTheEnd true to kill the created browser, false to keep it alive and return the page
* @returns {Promise} call this function via await
*/
registerAndroidApp: async function (projectName,
packageName,
appNickname,
jsonFilePath = null,
puppeteerPage = null,
fireFoxNightlyPath = '/Applications/Firefox Nightly.app/Contents/MacOS/firefox',
killBrowserAtTheEnd = true) {
return await _registerApp(projectName,
packageName,
appNickname,
jsonFilePath,
puppeteerPage,
fireFoxNightlyPath,
killBrowserAtTheEnd,
ANDROID)
},
```
# Register an iOS app:
```js
/**
* Will register a new iOS app to a given Firbase project
*
* @param projectName your project name
* @param bundleIdentifier your app's bundle identifier
* @param appNickname the name which be displayed in the project
* @param plistFilePath the path to save the plist file
* @param puppeteerPage (optional) puppeteer page to use (if not specified, will create a new one)
* @param fireFoxNightlyPath the path to your FireFox Nightly runner file
* In Windows that's usually your firefox.exe file (like 'C:/Program Files/Firefox Nightly/firefox.exe').
* In Mac that's usually your firefox file, located in your Firefox Nightly.app, inside the Applications dir
* @param killBrowserAtTheEnd true to kill the created browser, false to keep it alive and return the page
* @returns {Promise} call this function via await
*/
registerIOSApp: async function (projectName,
bundleIdentifier,
appNickname,
plistFilePath = null,
puppeteerPage = null,
fireFoxNightlyPath = '/Applications/Firefox Nightly.app/Contents/MacOS/firefox',
killBrowserAtTheEnd = true) {
return await _registerApp(projectName,
bundleIdentifier,
appNickname,
outputFilePath,
puppeteerPage,
fireFoxNightlyPath,
killBrowserAtTheEnd,
IOS)
}
```
## Additional notes
This is an automated module which uses [os-puppeteer-helper](https://github.com/osfunapps/os-puppeteer-helper-npm) to automate the app registration.
## Links
[npm os-puppeteer-helper](https://github.com/osfunapps/os-puppeteer-helper-npm)
## Licence
ISC
# os-firebase-project-creator-npm