To run this demo app, you'll first need a few tools to get your dev environment set up. The first, and most important, is Homebrew, the third-party package manager for macOS. You can find the installation command there, which you can run in a Terminal window.
Then you can install Node. Running the command found in the link will automatically install the latest Node.js version on your system, which this project is compatible with.
After Homebrew and Node are installed and ready, you'll need to install Yarn.
Once you've got those three prerequisites, you're ready to build the project and run it locally!
To run this demo app, navigate to where you cloned this repo to and at the top level of the directory, run yarn install. Once this has finished, run yarn client in one terminal window and yarn server in another to start up the front-end and back-end, respectively.
You'll likely notice upon first trying to use the demo app that you're not authenticated. In case you haven't already, you can sign up for an AssemblyAI account here and find your API key on your account dashboard.
Copy the .env.example file and name it .env, then copy your API key and replace the "YOUR_API_KEY" placeholder in .env. This will make sure that you're able to use the API and monitor the status of all of your requests in your processing queue on your dashboard. Now you're ready to experiment with our async API!
Considering this demo is open-source and you can modify the API requests, feel free to explore our documentation and learn more about the different parameters that you can send to the async API. You can also customize the kind of output you're expecting depending on your needs.
Thank you for checking out this demo, and if you have any questions, don't hesitate to reach out to us at [email protected]. Best of luck!