codingfu / candb

CanDB - CanDB is a flexible, performant, and horizontally scalable non-relational multi-canister data storage framework built for the Internet Computer.

CanDB

This repository holds the code for the CanDB project. CanDB is a flexible, performant, and horizontally scalable non-relational multi-canister data store built for the Internet Computer.

CanDB was the 2nd place finisher in the Internet Computer Supernova Hackathon, hosted by DFINITY in June of 2022.

Disclaimer: This library and repository is currently in beta development. This means the software has been tested and used by several independent parties, but that the maintainer(s) are not guaranteeing backwards compatibility between future releases at this time. This software and its APIs should not change considerably , except in the case of security issues or major feature improvement and otherwise considered mostly stable.

Documentation (start here)

Just getting started with CanDB? Head to the Documentation site, which contains tutorials and explains core CanDB concepts for those who want to dig deeper!

API Documentation

API documentation for this library can be found at https://candb.canscale.dev

Questions/Community

If you run into any issues, have questions, or feature requests feel free to file an issue in this repository. Also, you can join the CanScale discord and hop over to the CanDB Category.

Benchmarks

To view benchmarks for a single CanDB canister, see https://github.com/internet-computer/candb-benchmarks. CanDB is horizontally scalable, so these benchmarks keep constant performance as CanDB auto-scales, with the only limitation/bottleneck being simultaneous browser connection limits.

Milestones

See MILESTONES.md to view milestone status (in progress vs. completed features)

License

CanDB is distributed under the terms of the Origyn Foundation Software License (OFSL v1.0).

See LICENSE for details.