rvillamil / vws-js-app

Electron version for VWS project. Another pet project more...

VWS: Video WebSite Scraper - JS Version

JavaScript version for VWS project. Another pet project more...

Mainly uses my module called wvs-js-lib for web-scraping purposes.

Packed for Desktop with Electron support

Using

You can download the latest release for your operating system or build it yourself (see below).

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Run local

You'll need Node.js installed on your computer in order to build this library.

$git clone https://github.com/rvillamil/vws-js-app

then ..

$npm install

and finally ..

$npm start

Development

Maybe you'll need install wvs-js-lib at same level folder. e.g.

vws-js
 + vws-js-lib
 + vws-js-app

..then Link npm module before 'start'

$npm install && npm link ../vws-js-lib && electron .

Development tools: http-server

For testing the UI, whithout Electron, you can use http server, like http-server and run on local

• Install http-server

$npm install -g http-server

• Run on directory /app

$http-server .

Release on Github

We will look at how to create MacOS, Windows and Linux executables with an app icon. Maybe you need read official documentation on packaging problems

First update text files:

• Update CHANGELOG.md
• Update package.json with the new version
• Export Github Token

$export GH_TOKEN="{{Github Token}}"

• Publish release

$npm run release

How-to create package on several platforms

Maybe need create a package for :

OSX

$npm run package-mac

Windows

$npm run package-win

Linux

$npm run package-linux

All platforms

$npm run package-all

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• Christian Engvall and his electron-tutorial-app