search

wix-incubator / corvid

Download your Wix site, code in a local IDE, collaborate, use git, and more!
MIT License
38 stars 10 forks source link
deprecated

readme

DEPRECATED

This feature will be deprecated on July 20, 2021 and will no longer work. Therefore, we recommend you push your changes from the Local Editor and start using our online IDE as soon as possible (Please note: If the push command doesn’t work, you can still copy your local changes to the online IDE).

Corvid Local Development

Download your Wix site, code in a local IDE, collaborate, use git, and more!


no-maintenance-intended

DEPRECATED: The Corvid CLI allows you to download a Wix site and work on it locally. With this tool you can use your favorite development tools (e.g IDE, version control) to manage the code on your site, a local Wix Editor to edit your site's look and feel, and collaborate with others in building your site. Read more about how to use the Corvid CLI here.

Setup

Prerequisites

Node.JS version >= 10

Prepare a Local Project

  1. Enable Corvid using the Regular Editor in the site that you want to work on locally.

  2. Run create-corvid-app as follows, replacing the placeholders with values as described below:

    npx create-corvid-app <folder-name> [your-wix-site-url]
    • <folder-name>: A local directory where you want to store your local site project. If the directory doesn't exist, it will be created.
    • [your-wix-site-url](optional): The public URL of your published site or your site's Regular Wix Editor URL.

    Before your project downloads, if you are not already authenticated, a Wix authentication screen will open where you must enter your Wix credentials. You need to authenticate with a user whose role has Editor permissions for the site.

  3. If you did not provide a URL when running create-corvid-app you can clone your site into the project directory using the clone command:

    npx corvid clone <your-wix-site-url>

Work on Your Site Locally

When working on your local site, you edit your site's code in your preferred IDE and edit your site's look and feel in the Local Wix Editor.

Code

To edit your site's code, open your site's local project directory in your preferred IDE. When you make changes to your local code files, and you save those changes in your IDE, those changes are immediately synced to the Local Wix Editor.

Look and Feel

Editing the local version of your site's UI and previewing your local site is done through the Local Wix Editor.

To open your local site project in a Local Wix Editor:

  1. Navigate to the folder you specified above:

    cd <folder-name>

  2. Open a Local Wix Editor:

    npx corvid open-editor

Learn More

To learn about what else you can do with the Corvid CLI, run:

npx corvid --help

Or check out these articles about working on your Wix site locally: