I. About

A package for managing your Discord bot's structured Firestore. For an in-depth documentation visit the documentation website.

II. Getting Started

A. Installing

Run npm install on the command line or terminal.

npm install @ming-suhi/djs-firestore

B. Setting environment

1. Create a .env file in the root directory

   PROJECT_ID=
   CLIENT_EMAIL=
   PRIVATE_KEY=

2. Get project_id, client_email, and private_key of your Firebase service account and store it correspondingly.

C. Setting up manager

1. Require FirestoreManager

   const { FirestoreManager } = require('@ming-suhi/djs-firestore');

2. Attach an instance to discord client.

   client.db = new FirestoreManager();

3. Initialize guilds.

   client.db.initializeGuilds(client);

D. Creating base documents

1. Listen to guildCreate

   client.on('guildCreate', async guild => {
     // Code here
   });

2. Create guild doc.

   // If needed require GuildDocument
   const { GuildDocument } = = require('@ming-suhi/djs-firestore');
   // Check if a guild doc for the guild exist
   var guildDb = client.db.guilds.get(guild.id);
   // If not existing create document
   if (!guildDb) {
     var guildDb = new GuildDocument(guild.id);
     guildDb.initialize();
     await guildDb.update({id: guild.id, name: guild.name});
     // Put a reference to guilds
     client.db.guilds.set(guild.id, guildDb);
   }

E. Other methods

1. Get field method

   const guildDb = client.db.guilds.get(guildId);
   const fieldValue = guildDb.get('fieldName');
   console.log(fieldValue);

2. Update method

   const guildDb = client.db.guilds.get(guildId);
   await guildDb.update({"updated": true});

3. Delete method

   const guildDb = client.db.guilds.get(guildId);
   await guildDb.delete();

III. Contributing

A. Issues

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.

For help and questions about using this project, please open a GitHub issue.

B. Pull requests

1. Fork the project.

2. Create a topic branch from master.

3. Make some commits to improve the project.

4. Push this branch to your GitHub project.

5. Open a Pull Request on GitHub.

6. Discuss, and optionally continue committing.

IV. License

MIT © 明suhi