Hello! This discussion thread is to pitch ideas and ask questions about the upcoming ReplDB interface, ReplDB+, in ReplAPI.it! I wanted to hear some ideas about what to implement.

What is ReplDB+?

Unlike the original ReplDB, ReplDB+ is an opinionated, easy-to-use database built on top of the existing ReplDB setup. It will hopefully include many features that give ReplDB a feel similar to a modern database. Modeled after Cloud Firestore, ReplDB+ is a NoSQL database with collections that contain documents of data. It will have more expressive functions, ease-of-life methods, privacy features, and more!

- From the issue

I will update the issue with some progress every once in a while and push out the Database class under the experimental features flag. If you would like to test the Database class, do the following:

1. Install the package on a Repl (it has to be a Repl environment as part of security measures)

   $ npm install replapi-it

2. Use the package in your code

   import ReplAPI from 'replapi-it';
   const replapi = ReplAPI({
    username: 'your-username-here',
    experimentalFeatures: true,
   });

3. Create a database using ReplAPI.it

   // ...
   const myDatabase = new replapi.Database(process.env.REPLIT_DB_URL, 'some-salt', {
    ...databaseOptions // Reference the issue for database options
   });

4. Set the createDatabaseFlag to true to avoid errors working with the database

   // ...
   const replapi = ReplAPI({
    username: 'your-username-here',
    experimentalFeatures: true,
    createDatabaseFlag: true
   });
   // ...

5. Initialize the database

   // ...
   async function myFunction() {
    await myDatabase.init();
   }
   myFunction()

6. Use Database Functions! These are all asynchronous. For available functions, visit the issue.

The goal of this class is the make ReplDB easier to use for people on Replit! If you have any suggestions, please let me know in this issue or a thread below.