rambit

Welcome to the rambit monorepo. Feel free to look around.

• See PROJECTS for project goals and objectives.
• See the ROADMAP for (old) project direction and status.

Development

Setup

We use Nix for dev shells, enabled by direnv. You should have both of these installed, and you should have the flake features enabled for your Nix installation.

If all is well, enter the project directory and direnv should complain about the .envrc being untrusted. Trust it with direnv allow, and nix will begin to build the devshell. When that's complete, you should have a shell with all the necessary dependencies available. The devshell will also come with custom commands, which you can explore with the menu command.

Contributing

• Before submitting a PR, run the check command (an alias of nix flake check -L). This will test many things, and will also be run in CI.

Crate Map

Binaries:

• api (bin) - main action entrypoint over HTTP.
• cli (bin) - command line interface (mostly useless right now).
• daemon (bin) - task runner daemon.
• fetcher (bin) - temporary binary for the fetch pathway.
• migrator (bin) - database test data migration tool.

Leptos Projects:

• cart-app - cartographer leptos app logic.
• cart-frontend - cartographer leptos frontend wrapper.
• cart-server (bin) - cartographer leptos server.

Hexagonal:

• db - model-based database adapter interface, and TiKV implementer.
• health - health check framework
• hex - foundational hexagonal architecture traits.
• kv - key-value store interface and types, and TiKV implementer.
• prime-domain - service-level entrypoints for logic in the prime domain.
• repos - repository interfaces and implementers.
• storage - storage interface and implementers.

Tasks:

• rope - persistent distributed task interface.
• tasks - task types and logic.

Data:

• dvf - usage-specific newtypes used in models.
• model - domain model interface
• models - primary db model types.
• slugger - slug types.
• starc - smart pointer for static, owned, or ref-counted data.

Miscellaneous:

• art - macro-based ascii art.
• crunch - stream-based compression.
• mollusk - interfaces for HTTP errors, public and private.
• names - name generator.
• nasty - nix daemon interactions.
• stream-tools - stream tools.

License

This project is licensed under the GNU GPL-3.0 license.

• See the LICENSE file for the full GNU GPL-3.0 license text.

As of this moment, this workspace is not published on crates.io so the cargo license metadata is not populated. This has no bearing on the licensure of the code.