|
| 1 | +--- |
| 2 | +featuredImage: ./images/banner.png |
| 3 | +slug: Templates |
| 4 | +authors: ['Drake Costa'] |
| 5 | +photo: 'https://avatars0.githubusercontent.com/u/3144549?s=460&v=4' |
| 6 | +title: Announcing CodeSandbox Custom Templates |
| 7 | +description: |
| 8 | + Today we're excited to launch a new feature that we believe will speed up your |
| 9 | + prototyping workflow here in CodeSandbox! Say hello to Templates! |
| 10 | +date: 2019-07-02 |
| 11 | +--- |
| 12 | + |
| 13 | +Today we're excited to launch a new feature that we believe will speed up your |
| 14 | +prototyping workflow here in CodeSandbox! Say hello to templates! |
| 15 | + |
| 16 | +## What are Templates? |
| 17 | + |
| 18 | +We've found that for many of our users, after having used one of our built-in |
| 19 | +sandbox starters such as React, Vue, or Gatsby for the first time to prototype |
| 20 | +an application, they often want to create new projects using the same framework |
| 21 | +with a specific set of dependencies, folder structure, and configuration set up |
| 22 | +just the way they like it. |
| 23 | + |
| 24 | +This is so common that we decided why not make it easy for users to create their |
| 25 | +own custom templates which they can quickly bootstrap new projects with! Today's |
| 26 | +release is a beta of our new templates system, which we're planning to improve |
| 27 | +with a bunch of useful new features over time. |
| 28 | + |
| 29 | +In this early beta release, you can quickly turn any existing sandbox into a |
| 30 | +template with just one click. Let's take a look at how simple it is to get |
| 31 | +started with templates! |
| 32 | + |
| 33 | +## How to make your first Template |
| 34 | + |
| 35 | +Creating a template from an existing sandbox is really easy! From an existing |
| 36 | +sandbox, pull up the editor and open up the "Project Info" workspace in the |
| 37 | +upper left corner. If you've just opened one of our official templates, first |
| 38 | +fork it and make some changes. |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +You'll notice there's a new "Make Template" button. Click that and you'll see |
| 43 | +that your newly created template has been frozen. This is to help prevent making |
| 44 | +accidental changes to the template whenever you open it from the Dashboard or |
| 45 | +Create New Sandbox modal. You can toggle this on and off in the Project Info |
| 46 | +workspace of the template to make edits to the template itself. |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +You can also click on the color in the sidebar to change the color you assign to |
| 51 | +your template. This is to help distinguish it in your Dashboard and in the |
| 52 | +Create New Sandbox modal. |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | +You'll also notice that whenever you attempt to save changes to a frozen |
| 57 | +sandbox, a new modal will pop up asking you whether you would like to unfreeze |
| 58 | +it for editing or to fork it to create a new sandbox. |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +## Using Templates |
| 63 | + |
| 64 | +So now that you've created your first template, how can you use it? Just like |
| 65 | +the official templates, you can create a new sandbox from one of your templates |
| 66 | +via the Create New Sandbox modal. |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | +In the Overview tab, you'll see your most recently used templates up at the top. |
| 71 | +Switching over to the My Templates tab, you can browse through all of your |
| 72 | +custom templates. You'll also find all of your custom templates within the |
| 73 | +Dashboard under the My Templates tab. |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +## Teams |
| 78 | + |
| 79 | +As a team you can have your own templates as well! When you convert a sandbox |
| 80 | +owned by your team to a template you will be able to see them under "Team |
| 81 | +Templates". Team templates are very useful for teams that want to have a common |
| 82 | +starting point for their team. |
| 83 | + |
| 84 | +## Templates Roadmap |
| 85 | + |
| 86 | +We've got big plans to make templates even better and we'd love to hear your |
| 87 | +thoughts as you try them out! So what can you expect to see from templates in |
| 88 | +the future? |
| 89 | + |
| 90 | +Templates are designed to save you time and effort making new sandboxes. But |
| 91 | +wouldn't it be great if you could share a boilerplate app featuring your newly |
| 92 | +developed React library pre-configured and good to go? Have you ever visited the |
| 93 | +Search page and tried to find the perfect sandbox to start a new project with? |
| 94 | +Well we want to make that process a whole lot easier using templates! |
| 95 | + |
| 96 | +In the future you'll be able to make your templates public, which will list them |
| 97 | +on a new Community Templates page where you'll be able to quickly search and |
| 98 | +filter by keywords and dependencies. From there you'll be able to quickly view |
| 99 | +the details of a template, including a live preview and a README, as well as |
| 100 | +links to a template's GitHub repository and Issues page. You'll be able to watch |
| 101 | +other user's public templates, which will add them to your Create New Sandbox |
| 102 | +modal, allowing you to take advantage of what the community creates. |
| 103 | + |
| 104 | +As we make the sandbox execution environment more configurable, we hope that |
| 105 | +it'll be easy for framework maintainers to easily add and manage their own |
| 106 | +official templates. By making templates completely open-source, we hope to make |
| 107 | +it easier to issue updates and bug fixes. |
| 108 | + |
| 109 | +There's a lot in the pipeline that we're eager to share with you! Thanks for |
| 110 | +using CodeSandbox and we look forward to seeing all the awesome new things |
| 111 | +you'll create! |
0 commit comments