mjfaga/wick-editor

A free and open-source tool for creating games, animations and everything in-between!

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 zach@wickeditor.com.

Requirements

You'll need to download the following:

npm

Installation

1. Clone this repository:

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

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

cd wick-editor

3. Install all dependencies using this command:

npm install

Running the Editor

1. Run the editor with this command:

npm start

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

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

Bundling the Electron App (Desktop App)

This build process uses electron-packager and uses code from this tutorial: Building an Electron application with create-react-app.

1. Run 'npm run build'

2. Run electron-build-macos and/or electron-build-windows