Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# Velo: Working with the Wix CLI

The Wix CLI is a tool that allows you to work with your Wix site from your computer's terminal.

## Set up the Wix CLI

The CLI is an npm or yarn package that you install on your computer. Before setting up the CLI, make sure your site is [connected to GitHub](resourceId::c9ceea19-ebd3-4d8b-858d-d032f3a6f1ff#connect-your-site-to-github*fallback::https://github.com/wix-private/developer-docs/blob/6a99f46645349ce373b82bc24868762ecdde7bc0/velo-articles/Developer Tools/Setting%20Up%20Git%20Integration%20&%20Wix%20CLI.md#connect-your-site-to-github) and your site's repository is cloned on your computer.

1.  Open your computer's terminal.
2.  Run `npm install -g @wix/cli` or `yarn global add @wix/cli`.
    
    Once you've installed the CLI globally, you can use it with any Wix site repos on your computer.

## Commands

The CLI supports the following commands:

### wix -h

Displays a list of supported CLI commands in the terminal.

```
wix -h

Usage:
  wix [options] [command]

Commands:
  dev           [options]           Open the Local Editor that runs your local code
  install       [options] <package> Install a supported Velo package
  update        [options] <package> Update a Velo package
  uninstall     [options] <package> Uninstall a Velo package
  publish       [options]           Publish your site to production
  preview       [options]           Create a shareable version of your site before going live
  login         [options]           Log in to your Wix account
  whoami        [options]           Display the username of the logged in Wix user
  logout        [options]           Log out of your Wix account

Options:
  -v, --version                     Output the version number
  -h, --help                        Display help for command
```

You can also run `wix [command] -h` to get detailed help for a command.

### wix dev

Opens a site's Local Editor.

```
wix dev
```

For more information, see [Working with the Local Editor](resourceId::6ee9ea50-6ada-4800-9a28-b7c951818e20#open-the-local-editor*fallback::https://github.com/wix-private/developer-docs/blob/6a99f46645349ce373b82bc24868762ecdde7bc0/velo-articles/Developer%20Tools/Working%20with%20the%20Local%20Editor.md#open-the-local-editor).

### wix install

Installs a code package to a site's repo. 

```
wix install [options] <package-name>
```

If your site's repo has a `yarn.lock` file, the installer uses yarn to install packages by default. Otherwise, the installer uses npm by default. To specify which package manager to use, include an `--npm` or `--yarn` options flag.

Example install command:

```
wix install --yarn marked
```

Once the package is installed, a message is displayed in the terminal.

```
marked@4.0.16 successfully installed.
```

### wix update

Updates a code package that's installed on a site's repo.

```
wix update [options] <package-name>
```

### wix uninstall

Uninstalls a code package from a site's repo.

```
wix uninstall [options] <package-name>
```

### wix publish

Publishes a site.

```
wix publish
```

You can choose to use either the code in the default branch of a site's repo or the local code on your computer as the publishing source.

```
? What would you like to publish? › - Use arrow-keys. Return to submit.
❯   Latest commit from origin/main
    Local code
```

<blockquote class="important">

**Important:** 
Publishing your local code leaves your live site and your site's GitHub repo out of sync. If you publish from the repo later without pushing your local code, your local code is overwritten and may be lost.

</blockquote>

For more information, see [Publishing a Site with the Git Integration & Wix CLI](resourceId::1eeec65b-3a66-42a8-a022-90ae09b83c22#publish-from-the-wix-cli*fallback::https://github.com/wix-private/developer-docs/blob/6a99f46645349ce373b82bc24868762ecdde7bc0/velo-articles/Best%20Practices/Best%20Practices%20for%20Building%20a%20Site%20with%20Velo.md#publish-from-the-wix-cli).

### wix preview

Builds a preview version of a site. You must first publish your site before running this command. 

```
wix preview
```

You can build the preview from the code in the default branch of a site's repo or from the local code on your computer.

```
? What would you like to preview? › - Use arrow-keys. Return to submit.
❯   Latest commit from origin/main
    Local code
```

Once the preview site is ready, a URL to the site is displayed in the terminal.

```
Creating preview deployment...

Your preview deployment is now available at http://wix.to/JOaBagO
```

>**Note:** 
> *   This preview isn't a [test site](fallback::https://support.wix.com/en/article/about-test-sites) and doesn't appear in the Release Manager.
> *   The preview uses the live versions of any [HTTP functions](fallback::https://www.wix.com/velo/reference/wix-http-functions) exposed on your site. This means you can't use the preview to test changes to HTTP functions. To test HTTP functions, commit and push them to your site's repo and use [functional testing](resourceId::3c57e1b6-5d04-4120-93bb-2ac2b69f123e*fallback::https://github.com/wix-private/developer-docs/blob/6a99f46645349ce373b82bc24868762ecdde7bc0/velo-articles/Testing%20and%20Troubleshooting/About%20Functional%20Testing%20in%20the%20Backend.md) in the editor.

### wix login

Logs in to a Wix account. This allows the CLI to perform actions on that account's sites.

```
wix login
```

When you run the command, the Wix login page opens in your default browser.

### wix whoami

Displays the username of the currently logged in Wix user.

```
wix whoami
```

### wix logout

Logs out of a Wix account.

```
wix logout
```