Skip to content

knoxpo/firefunctions-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alt text

FireFunctions-CLI Build Status

Starter kit for Firebase Functions

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 <projectName> (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

exports.environment = {
  -- ALL YOUR GLOBLE VALUES --
};