@chat21/chat21-cloud-functions-public

1.0.36 • Public • Published

Chat21 - Firebase Cloud Functions

npm version

Chat21 is the core of the open source live chat platform Tiledesk.com.

Introduction

Chat21-cloud function is the backend module required for the operation of the other chat21 modules.

  • Send a direct message
  • Send a group message
  • Create a conversation for each message
  • Send the push notification for direct and group message
  • Send an info message to notify the creation of a group or a member joining

Pre requisites

You can find more info about Firebase Functions here https://firebase.google.com/docs/functions/get-started

Project building

git clone git@github.com:chat21/chat21-cloud-functions.git
cd functions
npm install

Project setup

  1. Login on the Firebase CLI with firebase login - it requires access to a web browser.

    • To log into the CLI in remote environments that don't allow access to localhost, use the --no-localhost flag. firebase login --no-localhost More info here https://firebase.google.com/docs/cli/
  2. Set up your Firebase project by running firebase use --add, select your Project ID

Deploy

Deploy to Firebase using the following commands:

  1. Go in the project root directory with

    cd ..
  2. Deploy

    firebase deploy

You can now see the deployed functions on the Firebase Console under Functions menu.

Tips

Run with Docker

If you prefer you can use a pre-built docker image to deploy the cloud functions to the Firebase project:

Run:

docker run -it chat21/chat21-cloud-functions sh

After that follow the "Project setup" and "Deploy paragraphs.

Test

Send your first message

  • Create a new user on the Firebase Console under Authentication Menu.
  • Select Email/Password for Authentication Provider
  • Click on "Add New User" and populate Email and Password field with for example : email = a@a.com, password = 123456
  • Get a JWT token calling JWT Authentication method as described here JWT Authentication
  • Send a new message using Send Message API with JWT Authentication as described here Send message

Advanced Setup Options

Read the Setup Options page

REST API

Read the REST API page

Readme

Keywords

none

Package Sidebar

Install

npm i @chat21/chat21-cloud-functions-public

Weekly Downloads

2

Version

1.0.36

License

AGPL-3.0

Unpacked Size

598 kB

Total Files

46

Last publish

Collaborators

  • micheletiledesk
  • andrealeo83
  • andrealeo83f21
  • nicolan74
  • andreasponziello
  • gab95