{"id":20688011,"url":"https://github.com/engineerjoe440/audi-hose","last_synced_at":"2025-07-09T20:07:20.752Z","repository":{"id":219017538,"uuid":"747451668","full_name":"engineerjoe440/audi-hose","owner":"engineerjoe440","description":"FOSS Speakpipe alternative built to connect audiences to the creators they love.","archived":false,"fork":false,"pushed_at":"2024-09-01T23:17:17.000Z","size":2072,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-30T00:08:03.502Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/engineerjoe440.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-24T00:27:12.000Z","updated_at":"2024-09-01T23:17:20.000Z","dependencies_parsed_at":"2024-04-13T04:43:34.928Z","dependency_job_id":null,"html_url":"https://github.com/engineerjoe440/audi-hose","commit_stats":null,"previous_names":["engineerjoe440/audi-hose"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/engineerjoe440/audi-hose","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2Faudi-hose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2Faudi-hose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2Faudi-hose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2Faudi-hose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/engineerjoe440","download_url":"https://codeload.github.com/engineerjoe440/audi-hose/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2Faudi-hose/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264502621,"owners_count":23618658,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T22:58:52.559Z","updated_at":"2025-07-09T20:07:20.710Z","avatar_url":"https://github.com/engineerjoe440.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://raw.githubusercontent.com/engineerjoe440/audi-hose/main/logo/audihose-logo.png\" width=\"250\" alt=\"logo\" align=\"right\"\u003e\n\n# audi-hose\n\nConnecting audiences to the creators they love with easy audio.\n\n## Installation\n\nAudiHose is built to be run in a [Docker](https://docs.docker.com/get-started/overview/)\n[container](https://www.redhat.com/en/topics/containers/whats-a-linux-container).\nThe easiest way to get AudiHose started is to use a [docker-compose](https://docs.docker.com/compose/)\nconfiguration to define the parameters for your application to use. Here's an\nexample:\n\n```yaml\nversion: \"3.9\"\n\n# AudiHose Example Configuration\nservices:\n  audihose:\n    image: ghcr.io/engineerjoe440/audi-hose:main\n    ports:\n      - 8082:80\n    restart: unless-stopped\n    environment:\n      # Optional Configuration Parameters\n      # - APPLICATION_SITE_URL: https://audihose.example.com\n      # - APPLICATION_STORAGE_PATH: ./recordings\n      # - SMTP_SERVER: smtp.example.com\n      # - SMTP_PORT: 587\n      # - SMTP_STARTTLS: true\n      # - SMTP_USERNAME: audihoseemail\n      # - SMTP_PASSWORD: \u003cinsert your smtp password here\u003e\n      # - SMTP_FROM_ADDRESS: audihose@example.com\n      # - NTFY_SERVER: https://ntfy.example.com\n      # - NTFY_TOPIC: audihose\n      # - NTFY_TOKEN: \u003cinsert your token here\u003e\n    volumes:\n      - ./config:/server/config\n      - ./recordings:/server/recordings\n```\n\n## Setup\n\n:warning: TODO\n\n---\n\n## Development\n\n### Linking frontend and backend (React/FastAPI)\n\nDeveloping Audi-Hose should be relatively simple. It falls into a few general\nsteps. Install the `npm` dependencies, build the frontend, install the `python`\ndependencies, then run the backend.\n\nWith some minor modifications made to the FastAPI configuration,\n[this guide on using Flask and React](https://blog.learningdollars.com/2019/11/29/how-to-serve-a-reactapp-with-a-flask-server/)\nwas used to develop the link between the two ecosystems.\n\n### Installing Frontend (`npm`) Dependencies\n\n1. `cd` to the `frontend/` folder.\n2. Run the command: `yarn install` (requires [yarn](https://classic.yarnpkg.com/lang/en/docs/install/))\n\n### Building Frontend\n\n1. `cd` to the `frontend/` folder.\n2. Run the command `yarn build`. This will generate all of the Javascript/CSS\nfiles needed in the `backend/audihose/static/react/` folder, and the `index.html`\nin `backend/audihose/templates/`.\n\n### Installing Backend (`python`) Dependencies\n\n1. Create a Python Virtual Environment with `python3 -m venv venv`.\n2. Activate the virtual environment.\n3. Run the command `pip install -r backend/requirements.txt`\n\n### Run the Application\n\n1. `cd` to the `backend/` folder.\n2. Run the command: `uvicorn audihose.main:app --reload --host 0.0.0.0`. This\nwill expose the application on all interfaces on the computer running the app.\nThis will allow you to test the app from other local devices.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineerjoe440%2Faudi-hose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fengineerjoe440%2Faudi-hose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineerjoe440%2Faudi-hose/lists"}