{"id":23524296,"url":"https://github.com/devboidesigns/firebase-wrapper","last_synced_at":"2026-04-16T18:02:55.303Z","repository":{"id":265692005,"uuid":"896474362","full_name":"DevboiDesigns/firebase-wrapper","owner":"DevboiDesigns","description":"The Firebase Node API Wrapper is a comprehensive package designed to simplify the integration and interaction with Firebase services in Node.js applications. This wrapper provides a streamlined interface for accessing Firebase 🔥 Authentication, Firestore, Realtime Database, Cloud Storage, and more. ","archived":false,"fork":false,"pushed_at":"2024-12-06T08:04:49.000Z","size":3688,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-12-25T18:15:22.907Z","etag":null,"topics":["firebase","nodejs"],"latest_commit_sha":null,"homepage":"https://firebase.google.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DevboiDesigns.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-30T13:11:54.000Z","updated_at":"2024-12-06T08:05:49.000Z","dependencies_parsed_at":"2024-11-30T15:20:55.229Z","dependency_job_id":"1317c1fe-32b5-4e01-99f4-4d96ef704118","html_url":"https://github.com/DevboiDesigns/firebase-wrapper","commit_stats":null,"previous_names":["devboidesigns/firebase-wrapper"],"tags_count":2,"template":false,"template_full_name":"DevboiDesigns/NPMTemplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevboiDesigns%2Ffirebase-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevboiDesigns%2Ffirebase-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevboiDesigns%2Ffirebase-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevboiDesigns%2Ffirebase-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevboiDesigns","download_url":"https://codeload.github.com/DevboiDesigns/firebase-wrapper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239217102,"owners_count":19601593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["firebase","nodejs"],"created_at":"2024-12-25T18:15:28.277Z","updated_at":"2026-04-16T18:02:50.277Z","avatar_url":"https://github.com/DevboiDesigns.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Firebase Node API Wrapper\n\nThe Firebase Node API Wrapper is a comprehensive package designed to simplify the integration and interaction with Firebase services in Node.js applications. This wrapper provides a streamlined interface for accessing Firebase Authentication, Firestore, Realtime Database, Cloud Storage, and more. It abstracts the complexity of Firebase's SDK, allowing developers to focus on building features rather than managing configurations and boilerplate code.\n\n## Key Features:\n\n- **Easy Initialization**: Quickly set up and initialize Firebase services with minimal configuration.\n- **Authentication**: Seamlessly integrate Firebase Authentication to manage user sign-in and sign-up processes.\n- **Firestore**: Access and manipulate Firestore collections and documents with ease.\n- **Realtime Database**: Interact with Firebase Realtime Database for real-time data synchronization.\n- **Cloud Storage**: Manage file uploads and downloads using Firebase Cloud Storage.\n- **Environment Configuration**: Support for multiple environments (development, production, testing) with environment-specific configurations.\n\n## Setup:\n\n1. Clone the repository.\n2. Copy the example environment file and fill in the API keys:\n\n```sh\ncp .env.example .env.test\ncp .env.example .env.prod\n```\n\n## Installation\n\nInstall the package using npm:\n\n```sh\nnpm install @devboidesigns/firebase-wrapper\n```\n\n## Usage\n\nImport the services and models from the package:\n\n```ts\nimport {\n  FBService,\n  GCSBucketName,\n  GSCService,\n  FBKeys,\n  FBSubKeys,\n  ERRKeys,\n} from \"@devboidesigns/firebase-wrapper\"\n```\n\n**Initializing the Firebase Service**\n\nCreate an instance of the `FBService` class to interact with Firebase services:\n\n```ts\nconst fbService = new FBService()\n```\n\n**Getting a Collection**\n\nYou can get a collection from Firestore using the `getCollection` method:\n\n```ts\nconst collection = fbService.getCollection(FBKeys.users)\n```\n\n**Getting Data from a Collection**\n\nTo get data from a collection, use the `getData` method:\n\n```ts\nconst userData = await fbService.getData(\"users\", \"userId\")\n```\n\n**Using Google Cloud Storage Service**\n\nCreate an instance of the `GSCService` class to interact with Google Cloud Storage:\n\n```ts\nconst gscService = new GSCService()\n```\n\n**Uploading a File to a Bucket**\n\nTo upload a file to a Google Cloud Storage bucket:\n\n```ts\nconst bucket = gscService.storage.bucket(GCSBucketName.PUBLIC_BUCKET)\nawait bucket.upload(\"path/to/local/file\", { destination: \"path/in/bucket\" })\n```\n\n# Running Tests\n\nTo run the tests, use the following command:\n\n```sh\nnpm test\n```\n\n# Building the Project\n\nTo build the project, use the following command:\n\n```sh\nnpm run build\n```\n\nThis documentation provides an overview of how to set up, install, and use the package, including examples of common operations.\n\n## Star on GitHub 🤩\n\nIf you like this tool please take a moment to\n[star this project on GitHub](https://github.com/DevboiDesigns/firebase-wrapper#start-of-content).\n\n[![GitHub stars](https://img.shields.io/github/stars/devboidesigns/firebase-wrapper?style=social)](https://github.com/DevboiDesigns/firebase-wrapper#start-of-content)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevboidesigns%2Ffirebase-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevboidesigns%2Ffirebase-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevboidesigns%2Ffirebase-wrapper/lists"}