Good Cash Contract Generation Functions

Cloud Functions for generating loan contracts

Read this!

From version 0.2.0 onwards, legacy user from App v1 will be disregarded.

Repository

This repo follows Vincent Driessen's branching model.

Cloud Functions

Setup

Installation

# Move to functions folder
cd functions

# install all dependencies
npm install

Development

Create local copy of functions:config

firebase functions:config:get > ./functions/.runtimeconfig.json

Serve functions locally for testing

firebase functions:shell

Deployment

# Deploy all functions
firebase deploy --only functions

# Deploy a specific function called 'validateUser'
firebase deploy --only functions:validateUser

If you choose to deploy all functions, you’ll probably encounter the following question:

Would you like to proceed with deletion? Selecting no will continue the rest of the deployments. (y/N)

You’ll need to answer n as we have other functions set up in another repository; choosing y will delete the functions in the other repo.

Documentation

live documentation will be available on contract-gen-doc.goodcash.co

Installation

# Move to functions folder
cd functions

# install all dependencies
npm install

Generate

# Move to functions folder
cd functions

# run doc generation
npm run docs

Deployment

Make sure you have the latest version of the documentation generated, then:

# Deploy documentation
firebase deploy --only hosting