/dogehouse-docs

Official repository for the dogehouse doc ๐Ÿš€

MIT LicenseMIT

description
Welcome to the dogehouse documentation

DogeHouse

 Taking voice conversations to the moon ๐Ÿš€

                         [![discord - users online](https://img.shields.io/discord/810571477316403233?style=for-the-badge)](https://discord.gg/wCbKBZF9cV) [![dogehouse - users online](https://img.shields.io/endpoint?color=FD4D4D&style=for-the-badge&url=https%3A%2F%2Fapi.dogegarden.net%2Fv1%2Fshields)](https://dogehouse.tv)

Contribute ยท Community ยท Documentation

Structure

Codebase Description
kousa Elixir API
shawarma Voice Server
dinner Puppeteer shenanigans
baklava Electron Wrapper
pilaf React Native App
feta Shared utils web/app
kibbeh Next.js frontend
kebab API Client

Branches

  • staging -> pr this branch for everything
  • prod -> don't touch, this is what's running in prod

Contributions

DogeHouse is open to contributions, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.

Please read CONTRIBUTING.md for details on this project.

DogeHouse Desktop

A desktop app built with Electron is available for Windows, Mac, and Linux.

There are different ways to get the Electron desktop app:

  • Get the official builds from here, in GitHub Releases

    for any platform.

  • Get it from AUR (unofficial package) for Arch/Manjaro or other Arch-based distro with

    yay -S dogehouse, using another AUR helper, or installing manually from the AUR.

  • Get the desktop client for Debian-based distros (including Ubuntu)

    from the official APT repo with these simple steps:

    • Add the repo with echo "deb http://ppa.dogehouse.tv/ ./" | sudo tee -a /etc/apt/sources.list > /dev/null

    • Add Ben Awad's GPG key with $(command -v curl>>/dev/null && echo "curl -o-" || echo "wget -q0-") http://ppa.dogehouse.tv/KEY.gpg | sudo apt-key add -.

    • Finally, update your local repository list and install DogeHouse

      with sudo apt update && sudo apt install dogehouse.

  • Get the snap for your systemd-powered Linux distro from either the

    Snap Store or in an terminal with

    sudo snap install dogehouse.

    • After installing the snap, you need to allow microphone access with

      sudo snap connect dogehouse:audio-record to be able to speak in rooms.

Notes:

  • If a warning message pops up on Windows, go to 'more info' and select 'Run Anyway'

  • Currently, the snap package's available channels are only edge as

    contributions for Baklava are merged almost on a daily basis. Tested

    versions that are stable will be promoted into stable in the future.

DogeReviewers

Contributors helping to review/merge pull requests:

Code of Conduct

Please read CODE_OF_CONDUCT.md for details on our code of conduct.

How to run locally

Check here on how to run locally

Why did you make this?

https://www.youtube.com/watch?v=hy-EhJ_tTQo

Attribution

For emojis, we use Twemoji