SpeakCaptcha -- The Captcha that makes you speak out the answer
The source code for SpeakCaptcha.
Checkout the documentation for instructions on how to use SpeakCaptcha.
First clone this repository and ensure that you have NodeJS with Yarn and Python with Poetry installed.
cdto thefrontendfolder.- run
yarn installto install necessary packages. - add this to the
.envfile:
VITE_SPEAKCAPTCHA_APP_ID=<your-speakcaptcha-app's-id>
This is used in the documentation and is optional.
4. you can either run the app here with yarn dev or build it with yarn build and copy over the dist folder to the backend.
You will need:
-
A deepgram account
-
A github account with a github oauth app created already
-
A locally hosted / cloud hosted mongodb database
-
Make sure you've setup frontend up until step
3first. -
cdinto thebackendfolder. -
run
poetry installto install python deps andyarn installto install gulp deps. -
build the frontend by
cding to thefrontendfolder and runningyarn build. -
copy the
distfolder to the root of thebackendfolder. -
create a
.envfile with this content:
# for github oauth
GITHUB_CLIENT_ID=client-id-of-github-app
GITHUB_CLIENT_SECRET=client-secret-of-github-app
MONGODB_URI=uri-of-mongodb
# for deepgram - be sure to create an api key
DEEPGRAM_KEY_ID=api-key-id
DEEPGRAM_KEY_SECRET=api-key-secret
- run the app with
yarn dev.
Example is hosted live at https://examples.speakcaptcha.tk.
cdinto theexamplefolder.- run
yarn installto install packages. - create a
.env.localfile and add this to it.
NEXT_PUBLIC_SPEAKCAPTCHA_URL=url-to-speakcaptcha (optional, in case you've hosted speakcaptcha yourself)
NEXT_PUBLIC_SPEAKCAPTCHA_APP_ID=id-of-the-speakcaptcha-app
SPEAKCAPTCHA_SECRET=secret-of-the-speakcaptcha-app
- run the app with
yarn dev.
You can use docker instead, by building the docker file using docker build -t speakcaptcha ., and running it with docker run -dp 5000:5000 -e ENV_VARS speakcaptcha.
Be sure to add all the environment variables from step 6 of the backend setup process in the command.