Git Product home page Git Product logo

easywebpagebundler's Introduction

Easy Webpage Bundler

What it does?

This is a program which takes a React/Next.js/HTML project and provides a simple way to bundle it into a local application using PyWebview.

Platforms

  • Windows
  • Linux

Quick Start

Installation

  1. Clone the repository

    git clone https://github.com/jchu634/EasyWebpageBundler
    
  2. Install the required packages

    # For Windows
    pip install -r requirements.txt
    # For Linux
    pip install -r linux_requirements.txt
  3. Add your React/Next.js/HTML project to the static folder

  4. Customise the build scripts to include your project name

    • package.iss (Windows)
      #define AppName "EasyWebPageBundler"
      #define AppVersion "1.0.0"
      #define AppPublisher "Example"
      #define AppExeName "EasyWebPageBundler"
      
    • build.ps1 (Windows)
      $applicationName = "EasyWebPageBundler"
      
    • build.sh (Linux)
      applicationName="EasyWebPageBundler"
      
  5. Add environment variables as appropiate to the .env file (Optional)

        ENV = "production"
        ERR404 = True
        APPNAME  = "EasyWebPageBundler"
    
    • ENV - The environment the application is running in. (production/development)
    • ERR404 - Whether you have a 404.html page when a page is not found. (True/False)
    • APPNAME - The name of the application.
  6. Run the build script

    .\build.ps1
    

Technologies

  • The webpages are rendered using PyWebview.
  • The pages are served using FastAPI.
  • The application is bundled using PyInstaller.
  • The windows iinstaller is created using Inno Setup.

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.