biota

biota

A simple, yet 💪, slightly opiniated database framework for Fauna, written in Javascript (Typescript).

🙃 You're on beta release. Don't get scared though, the api is pretty stable but tests need to be added to be fool-proof. (Thus, as of yet, Biota isn't production ready.)

❤️ Check the features and request the ones you would love to see in biota. (They arn't all listed yet!)

Getting some errors? Let us know!

import { Biota } from "biota";

// 4 lines to:
const db = new Biota({ secret: "<your-secret>", private_key: "123" });

// - scaffold the whole database (inc. users collection for ex)
await db.foundation();

// - add todos collection
await db.collection("todos").scaffold();

// - add autocomplete-search on name field
await db.collection("todos").index({ field: "name", ngram: true });

// 4 lines to:
// - create a user & login
let asUser = await db.user.register("[e-mail]", "password", {
  nickname: "Georgy",
});

// - create a todo
await asUser.collection("todos").insert({ name: "Remember to star this project" });

// - query a todo with $ngram (autocomplete behavior)
await asUser.collection("todos").find({ name: { $ngram: "star" } });
// output: [{ ref, ts, data: { name: "Remember to star this project" } }]

Getting Started

These instructions will take you through the few steps to get started playing with your Fauna database.

Prerequisites

You'll need to add biota either as a global or local (project) dependency.

yarn add biota // -G for global
// or
npm i biota // -G for global

Import

import { Biota } from "biota";
// or
const { Biota } = require("biota");

Instance

There are two ways to instantiate Biota.

1. You can use a admin/server key (or any secret key) as a paremeter.

const db = new Biota({ secret: "<your-secret>"})
// example
await db.query( q.Create(...) )

1. You can use the function .user.login(id, password) to log a user.

const db = new Biota()
const logged = await db.user.login("123", "super_password123")
// example
await logged.query( q.Create(...) )

Api

Even though you can query your database (same as you would do with the same fauna method query), the main power of Biota lives in its extended api.

⏳ Patience: It's coming.. :)

Helpers

const { q, factory, Page } = require('biota')
// q: export the query builder, same as fauna.query
q.If(..., true, false)
// factory: export the factory api (helpers that wrap FQL)
factory.create.database(name, options)

Running the tests

If you want to run the tests, you'll need to provide a FAUNA_KEY_TEST=<your-test-key> in a .env file.

:warning: Careful: At the moment tests covering everything yet. PR welcomed 😉

Built With

• fauna-db-js - Javascript driver for FaunaDB

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Gabin Desserprit instigator

See also the list of contributors who participated in this project. Join us :beers:

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

This lib wouldn't exist if I had not dug deep into Fauna FQL and got helped through the Fauna's slack community channel. In no order, I'ld like to thank, for their help and support, fauna's team (Brecht De Rooms, Ben Edwards, Marrony Neris, Leo Regnier, Summer, ,...) as well as other users like Eigil Sagafos 🙏