GithubHelp home page GithubHelp logo

hhy5277 / appifier Goto Github PK

View Code? Open in Web Editor NEW

This project forked from quanglam2807/appifier

0.0 1.0 0.0 29.04 MB

Node.js library which turns website into Electron app.

License: MIT License

JavaScript 99.71% HTML 0.18% CSS 0.11%

appifier's Introduction

Appifier npm version License: MIT Travis Build Status

Appifier is an Node.js library/CLI which turns any website into Electron app.

WebCatalog no longer uses this library under the hood.

Git history prior to April 2018 is squashed. You can still find it here & here.

Requirements

  • macOS 10.9+, Windows 7+ or Linux.
  • Node.js 8+.
  • Yarn

Usage

To create a native desktop app for duckduckgo.com:

Command Line

Install: npm install appifier -g or yarn global add appifier

appifier --id duckduckgo --name "DuckDuckGo" --url "https://duckduckgo.com" --icon ./icon.png

Programmatic API

Install: npm install appifier or yarn add appifier

const appifier = require('appifier');

appifier.createAppAsync(
  'duckduckgo',
  'DuckDuckGo',
  'https://duckduckgo.com',
  path.resolve(__dirname, 'test', 'icon.png'),
  path.resolve(__dirname, 'dist'),
)
  .then((destPath) => {
    console.log(`App has been created at ${destPath}`);
  })
  .then((err) => {
    console.log(err);
  });

How It Works

A template Electron app is included in the ./app folder. When the appifier command or programmatic API is executed, this folder is copied to a temporary directory with the appropriate parameters in a configuration file, and is packaged into an app with electron-packager.


API Documentation

See API.


Development

See DEVELOPMENT.

appifier's People

Contributors

quanglam2807 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.