README.md

⚡ Angular Firebase Functions

• Angular app using Firebase tools
• Firebase Functions used with express server to access a realtime database
• Note: to open web links in a new window use: ctrl+click on link

📄 Table of contents

• ⚡ Angular Firebase Functions
  • 📄 Table of contents
  • 📚 General info
  • 📷 Screenshots
  • 📶 Technologies
  • 💾 Setup
  • 💻 Code Examples
  • 🆒 Features
  • 📋 Status & To-Do List
  • 👏 Inspiration
  • 📁 License
  • ✉️ Contact

📚 General info

• Firebase project realtime database key-value pair created in Firebase Console
• Project service account created via Firebase Project Settings then Create Service Account/Node.js (default option)then Generate new private key that adds a json file to the user's PC. The path to this access key file is referenced in the express server index.ts file
• This is just a very simple example to demonstrate how a Firebase database function works

📷 Screenshots

📶 Technologies

• Angular v15
• Firebase v9 Cloud storage and authentication.
• Firebase Tools v11 CLI used to manage a Firebase project
• AngularFire v7 Angular library for Firebase
• Express v4 Node.js framework

💾 Setup

• Install dependencies using npm i
• Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
• In a 2nd terminal, cd to /functions and run npm i then npm run serve to install backend dependencies, create build file and start up Functions emulator
• navigate to localhost../api/databaseKey the realtime database value will be displayed
• Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
• Run ng update to update Angular

💻 Code Examples

• functions index.ts function to retrieve value from Firebase realtime database for key supplied

// get value corresponding to key supplied
app.get("/database_ref", (request, response) => {
  const db = admin.database();
  const ref = db.ref("database_ref");
  ref.once("value").then((value) => {
    response.send(value);
  })
      .catch((err) => console.error(err));
});

🆒 Features

• Firebase Cloud Functions can be used is a serverless framework that allows backend code to be run automatically in response to https requests and Firebase features.

📋 Status & To-Do List

• Status: Working
• To-Do: Add other functions and database key-values

👏 Inspiration

• Demos with Angular: Building Custom APIs on top of the Firebase Realtime DB

📁 License

• This project is licensed under the terms of the MIT license.

✉️ Contact

• Repo created by ABateman, email: gomezbateman@yahoo.com