https://github.com/mbejda/firedeploy
Smaller alternative to firebase-tools CLI for deploying single page applications to Firebase from serverless
https://github.com/mbejda/firedeploy
deployment firebase firebase-admin firebase-tools firedeploy serverless
Last synced: 8 months ago
JSON representation
Smaller alternative to firebase-tools CLI for deploying single page applications to Firebase from serverless
- Host: GitHub
- URL: https://github.com/mbejda/firedeploy
- Owner: mbejda
- License: mit
- Created: 2017-11-27T03:57:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-15T22:22:57.000Z (over 5 years ago)
- Last Synced: 2024-11-15T06:30:33.444Z (over 1 year ago)
- Topics: deployment, firebase, firebase-admin, firebase-tools, firedeploy, serverless
- Language: JavaScript
- Homepage: https://www.mbejda.com/i-present-to-you-firedeploy-a-small-firebase-deployment-cli-for-serverless/
- Size: 15.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## FireDeploy
FireDeploy is a small CLI tool which can also be used as a dependency module for deploying single page applications to Firebase from serverless environments. It is a lightweight alternative to firebase-tools that was built for environments that have memory constraints. I.E AWS Lambda, Google Functions. It does not rely on heavy dependencies such as firebase, firebase-tools(190M), firebase-admin and weighs < 10mb.
- Does not rely on Firebase modules
- Size < 10mb
- Only has 7 dependencies
- Can be used as a module dependency or as a CLI
### Installation
#### Module Dependency
```bash
npm install firedeploy --save
```
#### CLI
```bash
npm install -g firedeploy
```
## CLI
Example Usage :
```bash
$ firedeploy hosting -m "Message" -c "/fireDeploy/spec/test" -p "project name" -t "CI Token"
```
### Module
Usage Example :
```javascript
const FireDeploy = require('firedeploy');
let settings = {
releaseVersion: "someversion",
releaseMessage: "hello world!",
cwd: "./path/to/index.html directory",
projectId: "Firebase Project Name",
token: "Firebase CI Token",
debug: false
};
let fireDeploy = new FireDeploy(settings);
fireDeploy.prepareUpload().then((preparedFiles) => {
fireDeploy.upload(preparedFiles).then(_ => {
fireDeploy.release().then(_ => {
console.log("Done");
}).catch((e) => {
})
}).catch((e) => {
})
}).catch((e) => {
})
```
### Supports Chaining
```javascript
const FireDeploy = require('firedeploy');
let settings = {
};
let fireDeploy = new FireDeploy(settings);
fireDeploy
.setVersion("new version")
.setMessage("New Message")
.setProjectId("firebaseProject")
.setCWD("some/project/directory")
.setToken("ciToken").prepareUpload().then((preparedFiles) => {
fireDeploy.upload(preparedFiles).then(_ => {
fireDeploy.release().then(_ => {
}).catch((e) => {
})
}).catch((e) => {
})
}).catch((e) => {
})
```
If you are experiencing any issues please create an issue ticket or send me a tweet. [@notmilobejda](https://twitter.com/notMiloBejda)