{"id":21397573,"url":"https://github.com/multani/firestore-emulator","last_synced_at":"2025-03-16T15:17:51.592Z","repository":{"id":136259889,"uuid":"598763191","full_name":"multani/firestore-emulator","owner":"multani","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-16T04:11:31.000Z","size":666,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-09-16T17:20:25.239Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/multani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-02-07T19:03:18.000Z","updated_at":"2024-09-16T04:11:34.000Z","dependencies_parsed_at":"2023-10-15T05:40:12.037Z","dependency_job_id":"1e66435f-77ac-4701-815f-35ebbcd47104","html_url":"https://github.com/multani/firestore-emulator","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multani%2Ffirestore-emulator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multani%2Ffirestore-emulator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multani%2Ffirestore-emulator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multani%2Ffirestore-emulator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/multani","download_url":"https://codeload.github.com/multani/firestore-emulator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243886010,"owners_count":20363649,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-22T14:43:37.491Z","updated_at":"2025-03-16T15:17:51.560Z","avatar_url":"https://github.com/multani.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker image to run the Firestore emulator\n\nThis runs the Firestore emulator.\n\n## How to use?\n\n### Connecting to the emulator\n\nTo connect to the emulator using the Firebase SDK, export the environment variable:\n\n```sh\nexport FIRESTORE_EMULATOR_HOST=\"localhost:8080\"\n```\n\nThis is the address of the Firestore emulator and the SDK should automatically pick this up.\n\nAdditionally, you can configure the following environment variables:\n\n* `FIRESTORE_PROJECT`: the project used by the client SDK.\n\n  Configure your client SDK with the same as this variable to visualize the\n  content of the database from the emulator UI.\n\n  The Firestore emulator supports multiple projects in the same instance: if the\n  emulator and the client don't use the same project value, the client will\n  still run correctly, but you won't be able to see the content of the database\n  in the UI.\n\n  Default value: `google-cloud-firestore-emulator` (same value as in the client SDK)\n\n\n### Starting the emulator\n\nStart a container from this image exposing the following ports:\n\n* TCP/4000: the Firebase UI\n* TCP/8080: the Firestore database\n\nYou can use:\n\n```sh\ndocker run --rm -ti -p 4000:4000 -p 8080:8080 ghcr.io/multani/firestore-emulator:latest\n```\n\nOr via Docker Compose:\n\n```yaml\nversion: \"3.7\"\nservices:\n  firebase:\n    image: ghcr.io/multani/firestore-emulator:latest\n    ports:\n      - 4000:4000 # UI\n      - 8080:8080 # Firestore\n```\n\nYou can open the UI via http://127.0.0.1:4000\n\n\n#### GitHub Actions\n\nIn GitHub Actions, you can configure something like:\n\n```yaml\nname: Test\n\non:\n  push:\n    pull_requests:\n      - \"**\"\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n\n    services:\n      firestore:\n        image: ghcr.io/multani/firestore-emulator:latest\n        ports:\n          - 8080:8080 # firestore\n\n    env:\n      # Connect locally to the Firestore Docker container\n      # This variable should be automatically picked up by Firestore client SDK.\n      FIRESTORE_EMULATOR_HOST: localhost:8080\n\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n\n      # ...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmultani%2Ffirestore-emulator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmultani%2Ffirestore-emulator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmultani%2Ffirestore-emulator/lists"}