https://github.com/SpaceEEC/crux

Repository creating the umbrella documentation for all crux libraries
https://github.com/SpaceEEC/crux

Last synced: 3 months ago
JSON representation

Repository creating the umbrella documentation for all crux libraries

• Host: GitHub
• URL: https://github.com/SpaceEEC/crux
• Owner: SpaceEEC
• Archived: true
• Created: 2018-04-25T15:44:45.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-17T17:56:04.000Z (almost 5 years ago)
• Last Synced: 2024-07-31T20:40:48.529Z (6 months ago)
• Language: Elixir
• Homepage: https://crux.randomly.space
• Size: 1.66 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• discord-api-libs - crux - Repository creating the umbrella documentation for all crux libraries (Libraries / Elixir)

README

        
# 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](https://hex.pm/packages/crux_gateway)

 - [Documentation](https://hexdocs.pm/crux_gateway)

 - [Repository](https://github.com/SpaceEEC/crux_gateway)

 - [Umbrella Documentation](https://crux.randomly.space/Crux.Gateway.html)

## 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](https://hex.pm/packages/crux_rest)

 - [Documentation](https://hexdocs.pm/crux_rest)

 - [Repository](https://github.com/SpaceEEC/crux_rest)

 - [Umbrella Documentation](https://crux.randomly.space/Crux.Rest.html)

## Crux Structs

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

Links:

 - [Hex](https://hex.pm/packages/crux_structs)

 - [Documentation](https://hexdocs.pm/crux_structs)

 - [Repository](https://github.com/SpaceEEC/crux_structs)

 - [Umbrella Documentation](https://crux.randomly.space/Crux.Structs.html)

## 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](https://hex.pm/packages/crux_cache)

 - [Documentation](https://hexdocs.pm/crux_cache)

 - [Repository](https://github.com/SpaceEEC/crux_cache)

 - [Umbrella Documentation](https://crux.randomly.space/Crux.Cache.html)