https://github.com/knoxpo/firefunctions-cli

An open-source Firebase Functions Starter Kit
https://github.com/knoxpo/firefunctions-cli

firebase firebase-authentication firebase-database firebase-functions

Last synced: about 2 months ago
JSON representation

An open-source Firebase Functions Starter Kit

• Host: GitHub
• URL: https://github.com/knoxpo/firefunctions-cli
• Owner: knoxpo
• License: other
• Created: 2017-08-14T12:05:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-15T20:00:58.000Z (over 7 years ago)
• Last Synced: 2024-11-27T10:35:56.906Z (about 2 months ago)
• Topics: firebase, firebase-authentication, firebase-database, firebase-functions
• Language: JavaScript
• Homepage: http://knoxpo.com
• Size: 1000 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Alt text](https://firebasestorage.googleapis.com/v0/b/firefunctions-7a16e.appspot.com/o/firefunctions_cover5.png?alt=media&token=121a3cda-74cf-4b0c-a23d-b20c9009c435 "FireFunctions CLI")

# FireFunctions-CLI [![Build Status](https://travis-ci.org/knoxpo/firefunctions-cli.svg?branch=master)](https://travis-ci.org/knoxpo/firefunctions-cli)

Starter kit for Firebase Functions

- [Live Demo](https://us-central1-firefunctions-7a16e.cloudfunctions.net/api/)

- [Tutorials and Screencasts](https://medium.com/knoxpo)

## Features

- Firebase Authentication Token Validator

- Realtime Database CRUD

- Connect to other Google Cloud Services

- Base on Express.js

- Typing `TypeScript`!! 

## Usage

Create an account at https://firebase.google.com/

#### Pre-Setup FireFunctions

- Install Yarn if you don't have Yarn installed `brew install yarn`

- Install Firebase Tools if you don't already have it installed 

  `npm install -g firebase-tools` or `sudo npm install -g firebase-tools`

#### Setup FireFunctions

- `npm i -g fire-functions-cli`

- Run `firefunc new ` (`CamelCase` or `kebab-case`)

- Now, initialize Firebase Functions

- And final step: Deploy `firefunc deploy`

Now, you are all set!

#### Getting Started With FireFunctions

Working with FireFunctions makes Firebase Functions delpoy very easy. All your code goes in `./src` folder. Where all your express API code will go under `./src/api`, model creation will go under `./src/model`, trigger creation will go under `./src/triggers` and all other library initializtion will go under `./src/lib`.   

Full documentation will be updated soon.

Create the environment files below in `./src/environments`

#### environment.ts

```javascript

exports.environment = {

  -- ALL YOUR GLOBLE VALUES --

};

```