https://github.com/imagineeeinc/dino-db
🦕A small, document-oriented data base🦕
https://github.com/imagineeeinc/dino-db
database db dino dino-databse dino-db dinosaur document-database javascript js-database
Last synced: 5 months ago
JSON representation
🦕A small, document-oriented data base🦕
- Host: GitHub
- URL: https://github.com/imagineeeinc/dino-db
- Owner: imagineeeinc
- License: mit
- Created: 2022-04-24T18:34:24.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-18T22:45:00.000Z (9 months ago)
- Last Synced: 2025-10-18T04:57:58.996Z (8 months ago)
- Topics: database, db, dino, dino-databse, dino-db, dinosaur, document-database, javascript, js-database
- Language: JavaScript
- Homepage:
- Size: 326 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dino DB
🦕A small, document-oriented data base🦕
Dino DB is a light yet robust Database for portable and server applications. A document-oriented based on the design of [firestore](https://firebase.google.com/docs/firestore).
There are separate modules you can add to enhance your usage of DinoDB. There is a server extension which allows you to access the Database from external applications with http requests, there is also a cross platform client which adds a clean api to make requests to your database.
# Install
```shell
# npm
npm i dino-db
```
```js
// node
const dinoBb = require('dino');
// browser (skypack)
import * as dinoDb from 'https://cdn.skypack.dev/dino-db'
// browser module bundler
import * as dinoDb from 'dino-db'
```
Check out on how to expose your database to external apps with the [server extension](https://www.npmjs.com/package/dino-db-server).
Then check out on how to connect to the database with the [JavaScript based client](https://www.npmjs.com/package/dino-db-client)
# Usage
```js
//initialise databse in the app
var db = new db.databse({id: "food"})
// Use the normal api avalible
db.setInBook("ingredients", "sugar", {dishes: "sweet dish", price: 10.50})
db.getInBook('ingredients', 'sugar')
```
read more about [data hierarchy](#data-hierarchy) to see how to structure data
# Docs
[Read the docs here](https://imagineee.gitbook.io/dino-db/) (not finished)
# Data Hierarchy
Example
```
Food(database)
|
\_raw ingredients(book)
||
|\_sugar(page)
|| |
|| \_usage: "sweet dish"
|| image: "https://example.com/sugar.png"
|\_salt(page)
|| |
|| \_usage: "savoury items"
|| image: "https://example.com/salt.png"
|\_ ...(page)
|
\_dishes(book)
|
\_dounut(page)
| |
| \_ingredients: ["sugar", ...]
| instruction: {step1: ..., step2: ..., ...}
\_crackers(page)
|
\_ingredients: ["salt", ...]
instruction: {step1: ..., step2: ..., ...}
```