A library of templates to get you started faster and explore tools, frameworks, and runtimes.
Note: This repository is for non-official, non-supported, templates for IDX workspaces.
Project IDX allows anyone to make custom workspaces through custom templates. They require a few specific files that instruct Project IDX what to do when a workspace is being created.
First clone the repository down and make your own folder for your template.
git clone https://github.com/project-idx/community-templates
mkdir <your-template-path> && cd $_
Create the necessary files for the template: idx-template.json
and idx-template.nix
.
Test your changes with the template CLI or through a template URL such as https://idx.google.com/new?template=.
Check out the "Open in IDX Button Generator" tool in our documentation.
Once you have a tested template with an Open in IDX button, create a PR and request review.