WithFirebase Studio, you can simplify the steps for someone new toyour codebase to set up their development environment and get productive byadding an "Open in Firebase Studio" button.

For example:

• If you'reworking on a team with other contributors, you cancustomize your environmentprecisely for your project and then commit your.idx/dev.nix file toyour project's Git repository. That way, when a teammate imports yourGit repository inFirebase Studio, their new workspace will havethe exact same configuration as yours, complete with the same systempackages, IDE extensions, starter scripts, and more.

• If you'rebuilding a framework or library for others to use, youcan include a.idx/dev.nix file in your sample code repositories, sothat when a user imports your samples intoFirebase Studio, theycan skip the environment setup and jump straight into trying out yourframework. You can evenbuild your own, customtemplate as an opinionated,customizable starting point for your users.

After you're happy with your environment customizations, you can make iteven easier for others to import your project intoFirebase Studio byadding an "Open inFirebase Studio" button to your documentation, suchas your project'sREADME.md file.

Common "Open inFirebase Studio" entry points

There are several URL patterns available for an "Open inFirebase Studio" button:

• To link to theimport a Git repository flow, prefilled with your Gitrepository URL, use this URL pattern:

  https://studio.firebase.google.com/import?url=https://github.com/my-org/my-repo

  At this time, only GitHub repositories are supported (both private andpublic).

• To link to apredefined workspace template, find the templateyou're looking for in theTemplates page inFirebase Studio, and copy its URL, which should follow this URL pattern:

  https://studio.firebase.google.com/new/gemini

• To link to acustom template, prefilled with your template's GitHub URL,use this URL pattern:

  https://studio.firebase.google.com/new?template=https://github.com/my-org/my-template

• To open theApp Prototyping agent with a pre-filled prompt, use this URLpattern:

  https://studio.firebase.google.com/?prototypePrompt=Create an app that transforms sketches into a high-quality photograph withGemini

Add an "Open inFirebase Studio" button

Install theOpen inFirebase StudioSDK oruse this tool to generate the HTML for aFirebase Studio button: