Skip to content

collectiveai-team/asr-websocket-server

Repository files navigation

asr websocket server

ASR Websocket Server

Development

Project Organization

.
├── build                                   -> Docker building files & utils
│   └── core
├── notebooks                               -> Notebooks with experimentes and examples
│   └── ...
├── reports                                 -> Reports generated by results from 
|
├── resources                               -> general resources: models, datasets, cache, etc
│   ├── cache
│   ├── models
│   ├── datasets
│   └── ...
├── scripts                                 -> utils
└── awss           -> main package

Getting Started

Prerequisites

NOTE: personal API keys and credentials should be stored in a .env file in the .secrets directory, under the root directory of the project.

The .env file should be in the following format:

Installation

  1. Clone the repository:

    git clone https://github.com/collectiveai-team/asr-websocket-server
    
  2. Install the lastest version of Make:

    $ sudo apt update
    $ sudo apt install make
  3. Install the lastest version of Docker

VS Code development environment

  1. Install the Remote - Containers extension for VS Code.
  2. Open the project in VS Code.
  3. Click on the green button in the bottom left corner of the VS Code window and select the Reopen in Container option. Alternatively, you can run the Remote-Containers: Reopen in Container command from the Command Palette (Ctrl+Shift+P).
  4. VS Code will automatically build the Docker images and start the containers. This may take a few minutes. Once the containers are up and running, you can start developing in the VS Code development environment.

Contributors

Contributing

We welcome contributions to asr websocket server Feel free to submit a pull request with your changes or open an issue if you have any questions or suggestions.