Provide live captions to your students by leaving a tab open in the background. Students can get captions on their own devices.
- Sign up for a free Deepgram account.
- Create a new Deepgram API Key. Make sure your API Key has either an admin or owner role.
- Take note of your Deepgram API Key and Deepgram Project ID.
- Click on any of these buttons below to deploy this project on your hosting provider of choice.
git clone https://github.com/deepgram-devs/classroom-captioner
cd classroom-captioner
npm install
Rename .env.example to .env and populate the values. LECTURE_KEY is a value provided like a password to give transcription and broadcasting permissions - it should not be shared with students.
Run a development server with npm run dev, and a production server with npm start.
Interested in contributing? We ❤️ pull requests!
To make sure our community is safe for all, be sure to review and agree to our Code of Conduct. Then see the Contribution guidelines for more information.
We love to hear from you, so if you have questions, comments, or find a bug in the project, let us know! You can either:
- Open an issue in this repository
- Tweet at us! We're @DeepgramDevs on Twitter
Check out the Developer Documentation at https://developers.deepgram.com/.