Giter VIP home page Giter VIP logo

gitinstaller's Introduction

GitInstaller

A simple installer for software released on GitHub for Windows

Installer Preview

Usage

The installer is very easy to setup. All you have to do is to change the values inside the config.json file and you're ready to go.

{
    "project": "GitInstaller",
    "user": "daredloco",
    "repo": "GitInstaller",
    "unzip": true,
    "preview": true,
    "uninstall": true,
    "ignored-tags": ["v1.0"],
    "ignored-files": ["somefiletoignore.zip"]
}
  • project: The name of the project shown as Window Title
  • user: Your github username or the name of your company
  • repo: The name of your repository
  • unzip: Will unpack all zip files to the folder selected by the user and delete the zip files afterwards
  • preview: If true, preview releases will be included, if false they'll not but the user will always be able to enable them afterwards.
  • uninstall: If true, uninstall informations will be saved so the user can easily uninstall the software
  • ignored-tags: Releases with this tag will be ignored
  • ignored-files: Files with this name will be ignored

You can also add a zipsettings.json file to handle special cases like subdirectories for certain folders/files:

{
    "Subfolders": [
        { "Sub1": [ "GitInstaller.exe", "config.json" ] },
        { "Sub2": [ "FileThatDoesntExist.jpg" ] }
    ]
}

Create an array named "Subfolders" and create an object with the name of the subfolder as key and the files included as value (array). Afterwards add this file to your zip archive. It won't be unpacked!

Manual Installation

If the Installer won't find a "config.json" file in the same directory, it will show a prompt where you can enter the url of the repository.

WARNING: This is a preview function so exception handling isn't completely done!

Licenses

gitinstaller's People

Contributors

daredloco avatar dependabot[bot] avatar

Watchers

 avatar

gitinstaller's Issues

Folder won't get deleted if user uses the Uninstaller.

Describe the bug
The folder won't get deleted if the user uses the Uninstaller. This is a known bug (not even a bug but wasn't planned).

To Reproduce
Steps to reproduce the behavior:

  1. Uninstall a software with the uninstaller.
  2. Check the root path

Expected behavior
Empty folder should be deleted

Screenshots
Not necessary

Desktop (please complete the following information):

  • OS: All
  • Version: 1.5.3

Additional context
Will be fixed by version 1.6

Installer crashes if file to overwrite is opened

Describe the bug
If a file that will get overwritten is opened the Installer will crash.

To Reproduce

  1. Open a file that would get overwritten by the installer
  2. Start the installation process

Expected behavior
A check if a file that gets overwritten is open or not. If open show a promt to inform the user (and close the file if the user wants to do so)

Screenshots
Not needed

Desktop:

  • OS: All
  • Version: 1.8.2

Additional context
System.IO.IOException

Images and Links show up multiple times

Describe the bug
Images and Links will show up multiple times

To Reproduce
Load a version with an image/link inside the description !(Name)[Link]

Expected behavior
Image/Link only show up once

Screenshots
bug

Desktop (please complete the following information):

  • OS: All
  • Version: 1.8

Port to NET 5.0

Is your feature request related to a problem? Please describe.
Port the project from NET Framework 4.7.2 to NET 5.

Describe the solution you'd like
As version 1.8.4 is stable I can easily port version 1.9 to NET 5

Additional context
From version 1.9 upwards it will be NET 5.0 only.

Application crash if Image in Version Changes is invalid

Describe the bug
The installer will crash, if the image in version changes is of invalid format

To Reproduce
Load a version that has an invalid image or a link which ends with png/jpg but isn't

Expected behavior
Invalid image/link will be shown as normal hyperlink

Desktop (please complete the following information):

  • OS: All
  • Version: 1.8.1

Show License before installing

Describe the solution you'd like
Show a Window/Messagebox after the user clicks on "Install" which shows the license and an Accept/Decline button.
Check if necessary if its just an update.

Installer would mark Projects with an empty "ignored-tags" array as "No Releases found"

Describe the bug
When the 'ignored-tags' variable inside the config.json file is empty, no releases would be added to the Releases list.

To Reproduce
Steps to reproduce the behavior:

  1. make ignored-tags an empty array

Expected behavior
Still read the releases

Screenshots
Not necessary

Desktop (please complete the following information):

  • OS: All
  • Version 1.9.2.0

Additional context
Already fixed

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.