Git Product home page Git Product logo

glasswall-desktop's Introduction

Glasswall Desktop

Glasswall Desktop is a desktop application that provides multi file drag and drop rebuild workflow.

Membership

Avatar Name Role Time Zone
@kumarsudhish Sudhidh Kumar @kumarsudhish Delivery Manager/QA IST
@rajmbcoderx Sanchit Garg @rajmbcoderx Member IST
@gmuditdce Mudit Gupta @gmuditdce Member IST
@nishantswarup Nishant Swarup @nishantswarup Member IST

Current Objective and Key Results

Objective:

  1. Just drag and drop the files from your local hard disk, and the Glasswall Desktop will rebuild them using the Glasswall Rebuild API (currently hosted on Azure).
  2. To support different directory structures, give freedom to save the files at custom directory structure or at default location by maintaining the same directory as that of the parent folder.
  3. To support different platforms (Windows, MAC and Linux)
  4. To provide online and offline file-rebuild support. The online version to use glasswall-rebuild cloud hosting of rebuild engine to rebuild files. The offline version to use glasswall docker image to provide the ame functions offline.

Key Results:

  1. Build with Electron , react, it is aimed at providing multi file drag and drop rebuild workflow.
  2. It is a standalone application for MacOS, Windows and Linux operating systems.

Screenshot

Build Setup

Setup:

  • Clone the repo to your local directory
  • Navigate to the directory where package.json is placed
  • Run npm install. This will install required packages for this project which has been mentioned in the package.json

Run:

  • To build the source code npm run build. Build is requried to compile typescript
  • To start the application locally npm run start

Distribution Package:

  • To create distribution packages npm run dist. This will create the build binaries/exe to Mac, Windows, Linux platforms in the dist folder.

Important links

Installing

Warning: This software is under active development. Use at your own risk.

macOS

Download the latest glasswall-desktop release.

Mac users will need to follow the below steps on the app when you first launch it, until we have code signing set up

  • Step 1

glasswall-desktop Screenshot

  • Step 2

glasswall-desktop Screenshot

  • Step 3

glasswall-desktop Screenshot

TBD: Will automatically update when a new release is available.

Windows

Download the latest glasswall-desktop release

Windows users will need to follow the below steps to install and launch the application.

  • Step 1 Download the package from the above link, observe that .exe executable would be downloaded, glasswall-desktop-Setup-1.0.1.exe.

  • Step 2 Once executable has been downloaded, double click on the .exe and observe that installation starts.

glasswall-desktop Screenshot

  • Step 3 Observe that once the installation is complete, app is launched successfully showcasing the Welcome page

glasswall-desktop Screenshot2

  • Step 4 Click on Get Started to navigate to the Rebuild Files page.

glasswall-desktop Screenshot

  • Step 5

Rebuild offline with glasswall docker

  • Prerequisite - Ensure docker is installed on the machine running the rebuild with docker. Platform specific installation guides are avalaible at https://docs.docker.com/engine/install/

  • Click on the "Docker" icon in the sidebar menu.

glasswall-docker Screenshot

  • Choose the files to rebuild and the target directory.

  • For first time installations, the application will pull the glasswallsolutions/evaluationsdk:1 docker image from docker-hub registry.

glasswall-docker Screenshot

  • For first time rebuild, the application will ask for user permission to share file systems with docker

glasswall-docker Screenshot

Allow by clicking "Share It".

  • To avoid this notification in future, note the "temp" directory that the application asks to allow access to. Follow below steps to add this directory permanently in docker file sharing settings to avoid these notifications in the future

  • Open "Docker-Settings" from systemtray

glasswall-docker Screenshot

  • Open "File-Sharing" tab and click on the "+" icon

glasswall-docker Screenshot

  • Add the diectory noted above, for which the notification appears

glasswall-docker Screenshot

Once added, further rebuilds will not prompt to allow sharing the directory each time when using docker to rebuild files.

Linux Snap

Glasswall desktop is only available for 64-bit Linux systems. Download the latest glasswall-desktop release

Linux/Ubuntu users will need to follow the below steps on the app when you first launch it.

  • Step 1 Install the snapd package if not present in the linux/ubuntu version you are using.

glasswall-desktop Screenshot

  • Step 2 Once snapd package has been installed verify it has been installed successfully by running below command.

glasswall-desktop Screenshot

  • Step 3 Unzip the downloaded desktop package and move inside the directory. And run below command to install the package

glasswall-desktop Screenshot2

  • Step 4 Run below command to launch the desktop application

glasswall-desktop Screenshot

Installing from source

  1. Clone the repo
  2. Open the command prompt (On windows) and terminal on (Ubuntu/Linux/MAC)
  3. Run npm install
  4. npm run build
  5. npm run start

Building

IDE

To configure the codebase clone or download the codebase from the git and install the Visual Studio Code

Importing Project in Visual Studio Code

  1. Click on File in the Visul Studio tool bar.
  2. Select Open Folder option.
  3. Select the cloned glasswall-desktop folder.
  4. Observe that Project has been imported.

Project Structure

Release with git actions

To release the linux version following steps are required

  1. Create Ubuntu One account on https://login.ubuntu.com/
  2. After creating Ubuntu One account login to https://snapcraft.io/ using account created in step 1
  3. Follow the instruction to register your app https://snapcraft.io/docs/registering-your-app-name app name will be "glasswall-desktop"
  4. After app name registration export the login credential using "snapcraft export-login --snaps SNAP_NAME --channels edge -" command.
  5. Copy the output of the command and add it as a github secret with name "snapcraft_token". Link on how to add secrets in github account https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository

Debugging

Please change DEBUG variable to true and restart the app to start the electron debugger for code debugging purposes.

In this file

Open Issues Highlishts

  • Rebuild App: Signed build needs to be created for rebuild desktop app.
  • On selecting Hierarchy radio button, and uploading folder in single Hierarchy files are not getting saved in same Hierarchy format in target folder.
  • Upgrade installer not working on MAC OS
  • For Complete list of open issue can be found here Glasswall Desktop App Open Issues

Contributing

Bug reports are welcome on GitHub at https://github.com/k8-proxy/glasswall-desktop

Code Coverage

Coverage Status

Troubleshooting

  • MAC Application: Incase of cloud rebuild failure, follow below steps:
  • Delete the config folder under this path /Users//Library/Application\Support/glasswall-desktop
  • On command prompt run this command *rm -rf config ** to delete all the content in above path

glasswall-desktop's People

Contributors

nishantswarup avatar gmuditdce avatar rajmbcoderx avatar kumarsudhish avatar jaind1046 avatar diniscruz avatar dtollaku avatar b24repo avatar dependabot[bot] avatar dinis-cruz-gw 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.