Code Monkey home page Code Monkey logo

baileys-bottle's Introduction

Baileys bottle

A little package made by deadlinecode for storing all the data from baileys in whatever database you want to use by using typeorm

This package creates a store for a baileys bot instance. You can pass in a database connection to the functions and they will use that connection to create all the needed tables and save all the data to the database using typeorm, which supports all different kinds of databases.

TypeORM currently supports:

  • MySQL
  • MariaDB
  • Postgres
  • CockroachDB
  • SQLite
  • Microsoft SQL Server
  • Oracle
  • SAP Hana
  • sql.js

Installation

npm install baileys-bottle

Usage

Take a look at the information in the example folder

I wanna tweak it for my own use case

Sure thing! You can tinker with the package like this:

  1. Clone the repo
    git clone https://github.com/deadlinecode/baileys-bottle .
  2. Change stuff you wanna change
  3. Build the package
    npm build
  4. Install it in another nodejs project from wherever you saved it on your disk
    # inside your other project
    npm install /path/to/the/repo/named/baileys-bottle
    or alternatively run the example
    # inside the package folder
    npm run example

Found a bug or want to contribute because you're a cool person?

If you found an issue or would like to submit an improvement, please open an issue here.

If you actually have some spare time and want to contribute, feel free to open a PR and please don't forget to (create and) link the corresponding issue.
It's important so we can keep track of all the issues and feature requests that got resolved by PRs.

Known issues/feature requests (WIP)

  • Support multiple instance (currently only one instance is supported | mby by linking the corresponding stuff inside the auth table)

  • Add the ability to change the behavior of data changes (e.g. if you want to keep deleted messages in the database)

  • Improve the linking between tables (e.g. MessageDic.ts) by just linking to an account so resolving messages or other things to a single contact is easier

You need help or want to exchange about things

Well bad for you.
Jk.
I currently don't have a discord but you can find me in the WAWebSockets discord in the 🍸-baileys and 🏷️-others channels.

See ya over there and thanks for using my package ^^ <3

baileys-bottle's People

Contributors

h110m avatar deadlinecode avatar byexos avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.