Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.69 KB

README.md

File metadata and controls

44 lines (27 loc) · 1.69 KB

vectorly-electron-quick-start

Clone and run for a quick way to see Vectorly in Electron in action.

This is a minimal Electron application based on the Quick Start Guide within the Electron documentation. We've added a basic working version of Vectorly's upscaler to show how it works.

Use this app along with the Electron API Demos app for API code examples to help you get started.

To Use

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install

You'll then need to get your own token from the Dashboard, and replace the token in line 25 of index.html.

Finally, run the app

npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Resources

  • Website - Vectorly's Website
  • Docs - Instructions for Vectorly's Web Upscaler
  • API Reference - Full API reference for getting started with vectorly
  • Dashboard - Vectorly Dashboard where you can get your token

License

CC0 1.0 (Public Domain)