{"id":20974173,"url":"https://github.com/thirdweb-example/engine-deploy-local","last_synced_at":"2026-03-08T09:31:45.498Z","repository":{"id":237535952,"uuid":"790889135","full_name":"thirdweb-example/engine-deploy-local","owner":"thirdweb-example","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-26T23:05:31.000Z","size":34,"stargazers_count":1,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-19T09:21:05.185Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thirdweb-example.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-04-23T18:00:09.000Z","updated_at":"2025-03-26T23:05:35.000Z","dependencies_parsed_at":"2024-05-02T12:21:51.285Z","dependency_job_id":"6a49a773-018f-4c76-b82c-af8b24730cb3","html_url":"https://github.com/thirdweb-example/engine-deploy-local","commit_stats":null,"previous_names":["thirdweb-example/engine-deploy-local"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thirdweb-example/engine-deploy-local","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thirdweb-example%2Fengine-deploy-local","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thirdweb-example%2Fengine-deploy-local/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thirdweb-example%2Fengine-deploy-local/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thirdweb-example%2Fengine-deploy-local/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thirdweb-example","download_url":"https://codeload.github.com/thirdweb-example/engine-deploy-local/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thirdweb-example%2Fengine-deploy-local/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30251283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T08:59:44.879Z","status":"ssl_error","status_checked_at":"2026-03-08T08:58:02.867Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T04:27:02.815Z","updated_at":"2026-03-08T09:31:45.477Z","avatar_url":"https://github.com/thirdweb-example.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# thirdweb Engine Deploy Locally\n\nLet's deploy thirdweb Engine locally in easiest way possible. This repository is maintained by thirdweb community team.\n\n\u003e [!WARNING]\n\u003e 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](https://thirdweb.com/dashboard/engine?requestCloudHosted) or deploy a [self-hosted version](https://support.thirdweb.com/infrastructure/eRgkLPBdL1WJJLzAbuWrPZ/how-to-deploy-your-self-hosted-thirdweb-engine-on-the-railway/d97FnFt8e926FqniTaYxfD).\n\n## Requirements\n\n- [Docker](https://docs.docker.com/get-docker/)\n- [NodeJS](https://nodejs.org/en/download/)\n- [Postgres](https://postgresql.org/download/) (only supports v14+)\n- [Redis](https://redis.io/downloads/) (only supports v7.2.4+)\n- [thirdweb API secret key](https://thirdweb.com/dashboard/api-keys)\n- [Wallet address](https://portal.thirdweb.com/glossary/wallet)\n\n## Usage\n\n1. Clone the repository.\n2. Configure the `.env.example` file with your API secret key, wallet address, and ngrok auth token.\n3. Start Docker on your local machine.\n4. Run `npm run start` to deploy the engine locally, wait for it to finish.\n5. A new tab will open in your browser if you provided ngrok auth token in the `.env` file.\n   - This will be your ngrok URL to access the engine from anywhere. You can use this URL to import it to your thirdweb dashboard.\n6. If not, visit `https://localhost:3005` in your browser.\n7. That's it!\n\nFor detailed guide, visit [here](https://support.thirdweb.com/infrastructure/eRgkLPBdL1WJJLzAbuWrPZ/how-to-deploy-thirdweb-engine-to-your-local-machine/nhgkjfQ7S9b6Hbe1dp9uuh).\n\n\u003e [!NOTE]\n\u003e 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](https://hub.docker.com/r/thirdweb/engine).\n\n## Get Help\n\n- [Documentation](https://portal.thirdweb.com)\n- [Submit a ticket](https://support.thirdweb.com)\n- [Join Discord](https://discord.gg/thirdweb)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthirdweb-example%2Fengine-deploy-local","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthirdweb-example%2Fengine-deploy-local","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthirdweb-example%2Fengine-deploy-local/lists"}