This is a web application designed to easily create transcripts of audio files using AssemblyAI.
- Simple interface for uploading audio files.
- Automatic transcription generation powered by AssemblyAI.
- (Add more features as they are developed)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Before you begin, ensure you have the following:
- Git: For cloning the repository.
- Bun: (Recommended) For package management and running scripts. Installation instructions can be found at bun.sh.
- Alternatively, Node.js (which includes npm) or pnpm can be used.
- An AssemblyAI Account and API Key: You'll need this to use the transcription service. You can sign up at AssemblyAI.
-
Clone the repository (or download the code):
git clone <repository_url> # Replace with the actual URL if using Git cd assemblyai-transcriber
-
Install dependencies: It's recommended to use Bun:
bun install
Alternatively, you can use npm or pnpm if preferred:
# npm install # pnpm install
-
Set up Environment Variables:
-
Copy the example environment file:
cp .env.example .env.local
(Note: This command copies the template. You'll need to edit
.env.localnext.) -
Open the newly created
.env.localfile. -
Replace the placeholder value for
ASSEMBLYAI_API_KEYwith your actual AssemblyAI API key:ASSEMBLYAI_API_KEY=YOUR_ACTUAL_API_KEY_HERE
-
bun run devThis will start the development server. Open your browser and navigate to the URL provided (usually http://localhost:3000 or similar).
Pull requests run a read-only GitHub Actions check with the locked pnpm dependencies and a production build. The build uses a non-secret placeholder because it validates configuration shape without calling AssemblyAI.
GitHub Actions is intentionally disabled while this project is paused. Do not re-enable workflows or add automatic push, pull_request, or schedule triggers without explicit Lionel approval. Run the repository's documented checks locally and report the exact results; re-enable hosted CI only as part of an explicit project resumption.