Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ordo-pink/ordo
Ordo is an extensible engine for data storage.
https://github.com/ordo-pink/ordo
bun database editor kanban-board knowledge-base knowledge-graph markdown notes notion-alternative storage-api storage-engine typescript whiteboard wiki
Last synced: 2 months ago
JSON representation
Ordo is an extensible engine for data storage.
- Host: GitHub
- URL: https://github.com/ordo-pink/ordo
- Owner: ordo-pink
- License: agpl-3.0
- Created: 2023-02-19T12:41:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T20:13:46.000Z (2 months ago)
- Last Synced: 2024-11-12T20:32:19.728Z (2 months ago)
- Topics: bun, database, editor, kanban-board, knowledge-base, knowledge-graph, markdown, notes, notion-alternative, storage-api, storage-engine, typescript, whiteboard, wiki
- Language: TypeScript
- Homepage: https://ordo.pink
- Size: 229 MB
- Stars: 14
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Ordo.pink
> Bring Your Thoughts to ORDO
[](https://github.com/ordo-pink/ordo/actions/workflows/lint.yml)
[](https://github.com/ordo-pink/ordo)
Ordo is an extensible engine for data storage.
## Features
- Local first (even sign-up is optional!)
- Rich text editor for text files
- Good old file explorer view
- Labels (a.k.a. tags) are first-class citizens here
- File linking for horizontal relations
- Embedding files into other files as if directories never existed (in Ordo, every directory is also
a file!)
- Support for custom file properties
- User achievements for your leisure!
- Support for Notion-like databases, file/label relation graphs, kanban boards (~~SOON!~~),
Excalidraw whiteboards, images, videos (~~SOON!~~), and what not (~~NOT VERY SOON!~~)!
- Custom extensions support and extension store (~~SOON!~~)
- Public sharing (~~SOON!~~)
## Core Principles
There are four principles that lay a foundation of what Ordo is striving to be:
### 1. Open Source
Ordo.pink is completely open sourced, most of the code is available under **GNU AGPL 3.0** with some
libraries inside the `lib` directory licensed under **The Unlicense**. Don't use any of this code in
production, btw.
### 2. Local First
You probably didn't know that but "local first" is a fancy way to say "we don't want to pay for
storing your data, dude". And yeah, we don't want to, really. But, anyways, here's the deal:
- `FREE` without limits on space and upload size if you are not signed up (because we only store it
on your current computer lol)
- `FREE` for **1000 files** of up to **1.5Mb** if signed up (we store it on your current computer
and in the cloud so that you can get the info from your other computers if you sign in there).
What goes beyond the limit is only stored on your current computer
- `PAID` if you want to store your belongings of bigger sizes and amounts (pricing section to be
defined)
- `PAID` for team access because you can share the bill you know
- `PAID` for enterprises because the proletarians told us to show you Kuzkina Mat'
### 3. Security
The data you store on our end is encrypted both in transit and at rest. Finding content is also
obfuscated since files are never persisted by their name or path and bad guys would need to find
keys first, and the keys are stored discretely. As for local content - security is not an issue,
just don't leave your laptop at computer shops too much.
### 4. Extensibility
Ordo works as an engine that allows providing custom extensions - functions - that can bring new
features to Ordo, including support for new content types, dynamic editor components and views,
smart-contract/AI/LLM/blockchain/KGB/USSR commands for automation, and even full-featured apps
inside Ordo! Don't run Doom in the browser, run Doom in Ordo in the browser!
#### The state of extensibility
- As of now, you can add functions via pull requests here on GitHub (yes, meh)
- We are planning to add DevTools function and support for bringing in custom functions as files in
your Ordo storage **shortly**
- We are planning to function store for publishing custom functions **longly?**
## License
Most of the Ordo.pink code is licensed under **GNU AGPL 3.0**, and some of the libraries residing in
`lib` are licensed under **The Unlicense**. See individual packages inside `lib` for more details.
## Starting the project
To start `ordo`, you need to clone the repo and then run `boot/boot.sh`. The script will download
required binaries, compile `bin/*` files, link all the necessary files, and what not.
```sh
boot/boot.sh
```
You can then make it all up and running with
```sh
bin/run
```
## Contribution Guide
Not yet established. Sincerely yours, lunch club.
## Roadmap
Coming soon.
## Points of Interest
- `lib/oath` - dependency free promise extension that brings laziness, error branch type
definitions, simple cancellation and extended API
- `lib/result` - a sane alternative to try/catch in synchronous code flows
- `lib/option` - a nice way to say something is undefined
- `lib/switch` - switch operator gone wild
- `lib/maoka` - a 900-ish-byte renderer Ordo front-end is built with (imagine a world where React is
900-ish bytes)
## How to Get Started with Creating Functions
The best place to start is `lib/core` where all types reside. Those types are available globally, so
you can `Ordo.Metadata.Query` go brrr. We'll add some guides as soon as custom function development
becomes possible.
## Cheers?
Cheers 🍻