Upload from your computer
With your desired StackBlitz project open, drag and drop any files or a folder you want to import:
Import from GitHub
You can run any public GitHub repository on StackBlitz by adding the username and repo name to the URL like so:
If you want, you can also specify a branch, tag, or commit:
Whenever you push commits to GitHub, the corresponding StackBlitz project automatically updates with the latest changes ensuring that the code in your GitHub repository remains the source of truth.
While you can import from GitHub any projects with a
package.json, the unsupported technologies will not run. This includes backend languages not supported by Node.js (like PHP, Python, or Java), databases like MySQL and PostgreSQL that require a binary server process, and some specific npm packages which are not fully compatible with WebContainers yet.
Defining a launch command
Oftentimes, the first thing you do when opening a project is to launch a command, for instance, to run a development server.
Usually, these kinds of commands exist in the
scripts section of your project's
package.json file and you would manually type
npm run dev to execute them.
Using StackBlitz, you can provide an npm script to run automatically when the editor opens with the
startScript query parameter:
The following URL will open the
vitesse repository of the
antfu user, install the npm dependencies, and run
npm run dev command in the terminal:
Click on it and see the effect yourself!
Changing the title of the imported project
When importing a project from GitHub, the project title will default to the GitHub project owner's name and repository name.
You can customize the title of the imported project by adding the
title query parameter to the URL like so:
For instance, the URL from the previous section would now become:
You can chain the URL query parameters by adding the
& sign between them, for example:
Importing private projects
Importing private GitHub repos is a feature available with our memberships. If you're interested in becoming a member, check details on our StackBlitz Membership page.
2. Click on 'Connect repository' on the top left.
3. Click on the 'importing from an existing repository' link.
4. Paste your full GitHub repo URL.
The video below outlines a workaround to edit collaboratively in a private repo:
Importing or creating projects with StackBlitz API