Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gahabeen/biota
A simple database framework for Fauna
https://github.com/gahabeen/biota
client database database-framework driver fauna faunadb framework javascript query-builder
Last synced: about 1 month ago
JSON representation
A simple database framework for Fauna
- Host: GitHub
- URL: https://github.com/gahabeen/biota
- Owner: gahabeen
- License: mit
- Created: 2020-03-05T16:37:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T16:26:45.000Z (over 1 year ago)
- Last Synced: 2024-07-04T07:04:42.110Z (2 months ago)
- Topics: client, database, database-framework, driver, fauna, faunadb, framework, javascript, query-builder
- Language: TypeScript
- Homepage: https://gahabeen.github.io/biota
- Size: 4.02 MB
- Stars: 54
- Watchers: 5
- Forks: 2
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-fauna - Biota - A simple opiniated database framework for Fauna (Tools / Database frameworks)
README
# Biota has been living for a while in a new dedicated Organization over there: https://github.com/biotajs
# Developement is on hold before I find some time to make it available to the world :)
Gabin.
----
biota
A simple database framework to start your next project in 30s with FaunaDB
[](https://github.com/gahabeen/biota/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%22) [](https://www.npmjs.com/package/biota) [](https://www.npmjs.com/package/biota)  
Find the *raw* [documentation here](https://gahabeen.github.io/biota).
```js
import { Biota } from "biota";
```
```js
// 4 lines to:
const db = new Biota({ secret: "" });
// - 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 });
```
```js
// 4 lines to:
// - create a user & login
let asUser = await db.user().register("[email protected]", "password", {
nickname: "Georgy",
});
// - create a todo
await asUser.documents("todos").insert({ name: "Remember to star this project" });
// - query a todo with $ngram (autocomplete behavior)
await asUser.documents("todos").find({ name: { $ngram: "star" } });
// output: [{ ref, ts, data: { name: "Remember to star this project" } }]
```
## Current status
> Finishing up design and tests of the main API (400+ methods).
> 🙃 You're on preview 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](https://github.com/gahabeen/biota/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%22) and [request the ones](https://github.com/gahabeen/biota/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%22) you would love to see in **biota**. (They arn't all listed yet!)
> Found some errors? [Let us know!](https://github.com/gahabeen/biota/issues/new)
## Getting Started
These instructions will take you through the few steps to get started playing with your [Fauna](fauna.com/) database.
### Prerequisites
You'll need to add `biota` either as a global or local (project) dependency.
```js
yarn add biota // -G for global
// or
npm i biota // -G for global
```
### Import
```js
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.
```js
const db = new Biota({ secret: ""})
// example
await db.query( q.Create(...) )
```
2. You can use the function `.login(id, password)` to log a user.
```js
const db = new Biota()
const logged = await db.login("123", "super_password123")
// which is a shortcut for
const logged = await db.current.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
```js
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.database(ctx)(name).insert(options)
```
## Running the tests
If you want to run the tests, you'll need to provide a `FAUNA_KEY_TEST=` in a `.env` file.
> :warning: **Careful**: At the moment tests covering everything yet. PR welcomed 😉
## Built With
- [fauna-db-js](https://github.com/fauna/faunadb-js) - Javascript driver for FaunaDB
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning.
For the versions available, see the [tags on this repository](https://github.com/gahabeen/biota/tags).
## Authors
- **Gabin Desserprit** _instigator_
See also the list of [contributors](https://github.com/gahabeen/biota/contributors) who participated in this project.
Join us :beers:
## License
This project is licensed under the MIT License - see the [LICENSE.md](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](fauna-community.slack.com). 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** 🙏