Skip to content

Latest commit

 

History

History
83 lines (69 loc) · 4.31 KB

README.md

File metadata and controls

83 lines (69 loc) · 4.31 KB
Raw




Site | NPM Module | GitHub Repo

Backend Manager is an NPM module for Firebase developers that instantly implements powerful backend features. Be sure to look at which functions it exposes before using it!

📦 Install Backend Manager

First, install the package via npm:

npm i backend-manager

🦄 Features

  • Automatically create and deploy powerful management and marketing functions
  • Automatically keep your Firebase dependencies up to date

📘 Example Setup

After installing via npm, simply paste this script in your Firebase functions/index.js file.

// In your functions/index.js file
const Manager = (new (require('backend-manager'))).init(exports, {
  initializeApp: true
});

const { functions, admin, cors, Assistant } = Manager.libraries;

Next, run the setup command to allow backend-manager to configure your Firebase project with best practices and help keep your dependencies up to date!

npx bm setup

Your project will be checked for errors and any tips and fixes will be provided to you!

💻 Example CLI Usage

Note: you may have to run cli commands with npx bm <command> if you install this package locally.

  • npx bm v: Check version of backend-manager.

  • npx bm setup: Runs some checks and sets up your Firebase project.

  • npx bm config:get: Save Firebase config to your project.

  • npx bm config:set: Start an interface for setting a config value. You'll be prompted for the path and value.

  • npx bm config:delete: Start an interface for deleting a config value. You'll be prompted for the path.

  • npx bm serve <port>: Serve your Firebase project, defaults to port 5000.

  • npx bm test: Run Firebase test .js files in the ./test directory.

  • npx bm i local: Install local copies of this important module: backend-manager.

  • npx bm i production: Install production copies of this important module: backend-manager.

  • npx bm deploy: Deploy the functions of your Firebase project.

  • npx bm clean:npm: Delete, clean, and reinstall npm modules.

🗨️ Final Words

If you are still having difficulty, we would love for you to post a question to the Backend Manager issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

📚 Projects Using this Library

Somiibo: A Social Media Bot with an open-source module library.
JekyllUp: A website devoted to sharing the best Jekyll themes.
Slapform: A backend processor for your HTML forms on static sites.
SoundGrail Music App: A resource for producers, musicians, and DJs.
Hammock Report: An API for exploring and listing backyard products.

Ask us to have your project listed! :)