Starter Template - Documentation

Follow the guide on preparing a Firebase project for Firelayer

# Setting up Firebase - Guide

# Content

# Cloud Functions apps/functions

• Express API
• User management
• Triggers examples
• Scheduled jobs examples

# Administration Dashboard apps/admin

• Firebase Users Management
• Send auth emails with SendGrid
• Vue & Vuetify Components

# Installing

firelayer init myproject -t starter
# or add to an existing Firelayer project
firelayer add:template starter

Add a landing page website:

firelayer add:template landing

Don't forget to verify hosting properties in firebase.json and targets on .firebaserc after adding a template. More on firebase hosting targets here

# Install dependencies

yarn bootstrap or for NPM npm run bootstrap

# Developing

To start run yarn dev or npm run dev and the three applications should be ready on:

• Admin - localhost:8081
• Functions - localhost:5000/api/api
  (ports may change if already in use by other services)

You can run each separately by running:

• yarn dev:admin or npm run dev:admin
• yarn dev:functions or npm run dev:functions

# Adding an Administrator

1. Follow the steps on Getting Started to add a Service Account key to your project so you can run Firelayer CLI helpers.

2. If you don't have any users on this Firebase Project you can always create a new one using the Firelayer CLI or on the Firebase Console.

firelayer auth:add -u emailofuser@example.com -p password123

3. Add Administration privileges to user:

firelayer auth -u emailofuser@example.com --set-admin

And now you can login on the administration dashboard - localhost:8081 (if not running: yarn dev )

# Deploying

# Deploy Hosting and Cloud Functions

To deploy all applications and hosting run:

yarn deploy
# or if you use NPM
npm run deploy

You can run each separately by running:

• yarn deploy:admin or npm run deploy:admin
• yarn deploy:functions or npm run deploy:functions

# Deploy Cloud Functions Environment Variables

To deploy cloud functions environment variables run:

firelayer deploy:env

# Maintenance

Step needed: Getting Started - Get the Firebase Service Account key so your Cloud Functions and Firelayer CLI helpers can work locally.

To put the Users dashboard on maintenance mode:

firelayer down

To get out of maintenance mode:

firelayer up