Giter VIP home page Giter VIP logo

template-electron-browser's Introduction

Template Electron Browser

This is a template project for creating an Electron-based tabless-browser applications.

It is dessigned to render a website in a kiosk or panel display with minimal UI in fullscreen mode. It also can be used as a launcher for any web application in windowed mode.

Uses Electron Forge to build the app.

How to download it

Do not clone this repository unless you want to keep my git history.

Instead you should download the project as a ZIP file and extract its contents to your desired location, this way you will start with a clean project.

If you work from the CLI, I would recommend tiged for this:

npm install -g tiged
tiged syp1975/template-electron-browser your-project-folder

How to use it

  • Install Node.js.
  • Install project dependencies.
cd your-project-folder
npm install
  • Edit package.json and update it with your project data.
"name": "template-electron-browser",
"productName": "Electron Browser",
"description": "Electron-based tabless-browser application",
"author": "syp1975",
"version": "1.0.0",
"license": "MIT",
  • Replace application icons located in the assets folder:
    • icon.ico: Windows platform.
    • icon.icns: MacOS platform.
    • icon.png: All platforms.
  • Modify the default application configuration defined in main.js:
const store = new Store({
  defaults: {
    ...
  },
});
  • Start the application:
npm start

How to build the application installer

npm run make

License

MIT

template-electron-browser's People

Contributors

syp1975 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.