Let's deploy thirdweb Engine locally in easiest way possible. This repository is maintained by thirdweb community team.
Warning
Use this for demo / preview purposes only. This is not recommended for production use. If you wanna use thirdweb Engine in production, try cloud-hosted version or deploy a self-hosted version.
- Docker
- NodeJS
- Postgres (only supports v14+)
- Redis (only supports v7.2.4+)
- thirdweb API secret key
- Wallet address
- Clone the repository.
- Configure the
.env.examplefile with your API secret key, wallet address, and ngrok auth token. - Start Docker on your local machine.
- Run
npm run startto deploy the engine locally, wait for it to finish. - A new tab will open in your browser if you provided ngrok auth token in the
.envfile.- This will be your ngrok URL to access the engine from anywhere. You can use this URL to import it to your thirdweb dashboard.
- If not, visit
https://localhost:3005in your browser. - That's it!
For detailed guide, visit here.
Note
We recommend to use the versioned image instead of latest tag in the docker-compose.yml file. You can find the versioned image list in the Docker Hub.