Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phfaist/zoodb-example
Example of a simple zoo database & website powered by ZooDb
https://github.com/phfaist/zoodb-example
Last synced: about 2 months ago
JSON representation
Example of a simple zoo database & website powered by ZooDb
- Host: GitHub
- URL: https://github.com/phfaist/zoodb-example
- Owner: phfaist
- Created: 2023-08-02T12:55:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-28T16:06:50.000Z (9 months ago)
- Last Synced: 2024-10-12T13:45:10.573Z (3 months ago)
- Language: JavaScript
- Size: 1.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example Zoo Using ZooDb
In this repository we have a very simple illustrative example of a usage of our
[ZooDb framework](https://github.com/phfaist/zoodb)
for building a modest-scale database, or "Zoo," to organize a collection of
objects or concepts in a semi-structured form.In this example, the ZooDb database is used to store a database of people with
parent/child and friend relationships. The source data providing the content
of the database is a collection of YAML files.
YAML is a common and useful markup language to store structured data.
You can [google "YAML tutorial"](https://google.com/search?q=YaML+tutorial)
or check out the language's [Wikipedia
page](https://en.wikipedia.org/wiki/YAML).)The database object schemas are in `schemas/`. The schemas define what exactly
is being stored in the database.The data, provided in YAML files, is in the folder `data/`.
Minimal JS code to load the people DB in memory is in `peopledbjs/`. If you want
to produce any different form of output, e.g., a handbook or print form of the
database, then you can use this code to load the database in memory and use it
to generate the required output.A simple example static website, generated with the given data, is
in `website/`. The website
is powered by [11ty](https://11ty.dev/) and [parcel](https://parceljs.org/).**To build the website:** refer to the [README](website/README.md) file
in the folder `website/` folder.See also [the documentation for the ZooDB
package](https://zoodb.readthedocs.org/).