About ST.db

ST.db is a powerful npm package that provides an easy-to-use key-value interface for managing various types of databases, both local and cloud-based. This package simplifies the process of reading, writing, and seamlessly switching between different database engines. Whether you're working with local databases or cloud-based solutions, st.db offers a straightforward and efficient way to interact with your data.

Installation

To install the @st.db/firebase package and its associated database drivers, follow these steps:

1. Install the main @st.db/firebase package:

npm install st.db @st.db/firebase

Usage

Using Node.js require()

const { FirebaseDriver } = require('@st.db/firebase');

TypeScript/ES Module support

import { FirebaseDriver } from '@st.db/firebase';

Deno support

import { FirebaseDriver } from 'npm:@st.db/firebase';

Using FirebaseDriver

The FirebaseDriver enables interaction with Firestore databases. Here's how to use it:

import { Database } from "st.db";
import { FirebaseDriver } from "@st.db/firebase";

// Replace these values with your actual Firebase configuration
const firebaseConfig = {
  apiKey: "your-api-key",
  authDomain: "your-auth-domain",
  projectId: "your-project-id",
  storageBucket: "your-storage-bucket",
  messagingSenderId: "your-messaging-sender-id",
  appId: "your-app-id",
};

const collectionName = "my_collection"; // Optional: specify the collection name

const options = {
  driver: new FirebaseDriver(firebaseConfig, collectionName), // Specify the FirebaseDriver and the configuration
};

const db = new Database(options);

Links

• Discord Support Server
• Documentation

Sponsors

• Love what I do? Send me some coffee!? ☕

• Can't send coffees? 😥 Nominate me for a st.db: Reviews | Openbase instead! Your support will help me to continue working on open-source projects like this. 🙏😇

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Discord Server .

Did you find it difficult to use?

You can see the Documentation of the st.db package to know all the details

License

CC BY-NC-ND 4.0