Templates > Board Template - Documentation

Board Template - Documentation

Follow the guide on preparing a Firebase project for Firelayer

# Setting up Firebase - Guide

# Content

# Board Page apps/board

  • Sign In with Google and Anonymous
  • Realtime suggestion board
  • Vue with Vuetify Components

# Installing

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

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:

  • Board - localhost:8082
    (ports may change if already in use by other services)

You can run each separately by running:

  • yarn dev:board or npm run dev:board

# 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:board or npm run deploy:board

# 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 board on maintenance mode:

firelayer down

To get out of maintenance mode:

firelayer up
Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!