firetable
v1.5.1
Published
CLI tool to simplify firetable deployment processes
Downloads
15
Readme
Firetable CLI
The Firetable CLI automates the steps required to set up the Firetable app and other operations on your computer.
Contents
Installation requirements
Make sure you have the following installed:
- Git
- Node 10, 11, or 12
- Yarn
- Firebase CLI 8
Also, make sure you are logged in to your Firebase account in the Firebase CLI:
firebase login
Install the Firetable CLI
Install the Firetable CLI globally.
yarn global add firetable
Commands
Create a new project
firetable init [directory]
Run Firetable locally
Before you run locally, make sure you have a Firebase project set up. Instructions →
firetable start
Update Firetable
Fetches the latest version of firetable from a spicific branch (default:master)
firetable update [branch]
Deploy to Firebase Hosting
First, make sure that you have created a site in your Firebase project. Open Firebase console
firetable deploy
Set user roles for Firestore Security Rules
Firetable has role-based access controls using Firestore Security Rules and custom claims in Firebase Authentication. Read more →
You can use the Firetable CLI the roles of Firebase Authentication users.
Download your project’s service account private key file from the Firebase Console in Project Settings > Service Accounts. This is used to run Firebase Admin SDK commands on your computer.
Save the JSON file, without renaming it, in your current working directory.
The file name should look likePROJECT-ID-firebase-adminsdk-ALPHANUMERIC-CHARACTERS.json
Run the following command to set the roles of the Firebase Authentication user.
You can view all users in Firebase Authentication and find their emails in the Firebase Console.firetable auth:setRoles <email> <roles>
Deploy Firetable Cloud Functions
Easily deploy Cloud Functions used to extend Firetable. You can choose which functions you want to deploy.
firetable functions:deploy