# wick-editor

**Repository Path**: zcenet-ryan/wick-editor

## Basic Information

- **Project Name**: wick-editor
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-04-19
- **Last Updated**: 2022-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">
  <br>
  <a href="https://editor.wickeditor.com/"><img src=".github/images/logo.svg" alt="Wick Editor" width="25%"></a>
  <br>
</h1>

<p align="center">
  <a href="https://github.com/Wicklets/wick-editor/issues">
      <img src="https://img.shields.io/badge/contributions-welcome-orange.svg"/>
  </a>
  <a href="https://www.patreon.com/WickEditor">
      <img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&amp;style=flat"/>
  </a>
  <a href="LICENSE.md">
    <img src="https://img.shields.io/badge/License-GPLv3-blue.svg"/>
  </a>
  <a href="https://twitter.com/wickeditor?ref_src=twsrc%5Etfw">
    <img src="https://img.shields.io/twitter/follow/wickeditor?style=social&logo=twitter" alt="follow on Twitter"></a>
</p>

<h1>Wick Editor</h1>

The Wick Editor is a free and open-source tool for creating games, animations, and everything in-between. It's designed to be the most accessible tool for creating multimedia projects on the web.

<p align="center"><img width="100%" src=".github/images/editor.svg"></p>

## Getting started

These instructions are for MacOS and Linux, we currently don't have instructions for Windows, but if you need help please feel free to email contact@wickeditor.com.

### Requirements

You'll need to download the following:

- [npm](https://www.npmjs.com/get-npm)

### Installation

1) Clone this repository:

    ```bash
    git clone https://github.com/Wicklets/wick-editor/
    ```

2) Using the command line, change directories into the newly created `wick-editor` folder:

    ```bash
    cd wick-editor
    ```

3) Install all dependencies using this command:

    ```bash
    npm install
    ```

### Running the Editor

1) Run the editor with this command:

    ```bash
    npm start
    ```

2) Open a web browser and go to this URL:

    ```bash
    localhost:3000
    ```

Have fun hacking on Wick! 🎉

### Deploying to Production

To deploy, you'll need to have push access to this repo.

1) Test the production build by using `npm predeploy`

2) Run `npm run deploy`

### Deploying to Prerelease

1) Run `npm run prerelease-deploy`

## Support

<a href="https://www.patreon.com/WickEditor">
	<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
</a>

## License

Wick Editor is under the GNU v3 Public License. See the [LICENSE](LICENSE.md) for more information.

## Links

* [Wick Editor Site](https://www.wickeditor.com)
* [Wick Editor Community Forum](https://forum.wickeditor.com/)
* [Follow on Twitter](https://twitter.com/wickeditor)
* [Follow on Facebook](https://www.facebook.com/wickeditor/)



## Building and Releasing the Desktop App 

Please refer to this Wiki entry for information on our dektop build processes! [https://github.com/Wicklets/wick-editor/wiki/Building-Desktop-Editors-for-Release](https://github.com/Wicklets/wick-editor/wiki/Building-Desktop-Editors-for-Release).

If you are familiar with electron-builder, electron-packager, or have experience building desktop electron apps for production, we could use your help! Please message us or open an issue.

## Support From

<a href="https://www.mozilla.org/en-US/moss/">
	<img src="https://www.wickeditor.com/static/media/mozilla.787ef555.svg" alt="Mozilla Open Source Support" height="100px"/>
</a>

<a href="https://studioforcreativeinquiry.org/frfaf-projects">
	<img src="https://www.wickeditor.com/static/media/studio.35c7a92e.svg" alt="Frank-Ratchye Fund for Art at the Frontier" height="100px"/>
</a>

<a href="https://www.du.edu/ahss/opensourcearts/">
	<img src="https://www.wickeditor.com/static/media/cosa_logo.9af883a9.png" alt="Clinic for Open Source Arts" height="100px"/>
</a>


## Testing Support From

<a href="https://www.browserstack.com/"><img src=".github/images/browserstack.svg" alt="Browser Stack" width="25%"></a>