vox

main branch1 version
  • main branchlatestNov 6, 2026

github.com/tamdaz/vox

API for exchanging messages between users in conversations.

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  vox:
    github: tamdaz/vox
    branch: main

main is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
>= 1.22.2
License
MIT
Author
tamdaz
Targets
  • server from src/server.cr
  • console from src/console.cr

Dependencies

Runtime Dependencies

README

vox

vox is an API for exchanging messages between users in conversations, built with the Athena Framework.

Installation

Requires Crystal 1.22.2 and SQLite.

First, install dependencies:

shards install

Usage

Create your local configuration:

cp .env.example .env

Set the host, port, and database URL in your .env file.

Run the database migrations:

shards run console -- orm:mig:mig

Start the server:

shards run server

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/tamdaz/vox/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • tamdaz - creator and maintainer

Documentation

Read the API docs

Built from the current release. The first visit to a release nobody has asked for starts its build.

Links

This branch

Branch
main
Seen
Nov 6, 2026
Crystal
>= 1.22.2
Indexed
yes

Dependents

No indexed shard depends on this one yet.

Repository

github.com/tamdaz/vox

Metadata

Created
Nov 6, 2026
Updated
Nov 6, 2026
Synced
Nov 6, 2026
Versions
1