SpaceEEC / crux

Repository creating the umbrella documentation for all crux libraries

Crux - Umbrella Repository

This repository is responsible for generating the umbrella documentation available here: https://crux.randomly.space

Child Repositories:

Crux Gateway

Handles Discord's sharded gateway api, including reconnecting, zombie connections, and ratelimiting.
Forwards normalized packets as maps with atom keys via gen_stage producers. (One per shard)

Links:

• Hex
• Documentation
• Repository
• Umbrella Documentation

Crux Rest

Handles Discord's RESTful bot api, including queues, rate limits, and retries.
Returns transformed Crux.Structs directly. (Blocks calling process when rate limited)

Links:

• Hex
• Documentation
• Repository
• Umbrella Documentation

Crux Structs

Provides Elixir Structs for Discord's api objects, as well as helper structs.

Links:

• Hex
• Documentation
• Repository
• Umbrella Documentation

Crux Cache

Provides caches to add, fetch, update, and remove Crux.Structs. Also provides a behaviour to implement custom caches which may override the default ones. (For example using redis instead of ets)

Links:

• Hex
• Documentation
• Repository
• Umbrella Documentation