Giter VIP home page Giter VIP logo

desktop's Introduction

⚠️ rucio/desktop is not maintained

This repository is not maintained and has been archived.

Rucio Desktop

Rucio Desktop

GitHub package.json version

Description

Rucio Desktop is a new and easier way to use Rucio with a modern graphical user interface. You can download Rucio Desktop and use it as a client or a Rucio admin. It provides a simpler workflow in comparision to traditional command-line interface provided by Rucio for both type of users.

Desktop

Key Features

  • Multi-Account Setup: Add all your accounts associated with Rucio in the app and manage them in a really efficient way, right from your desktop in a few clicks.
  • Explorer: Browse the Rucio namespace for all your connected servers using the FUSE-POSIX interface.
  • Storage: Manage RSE Configurations & Protocols for your connected Rucio Instance. Rollback settings to previous versions in a click.
  • Admin and User Panel: Login to the app as a Rucio Admin or a Rucio User and manage all your account settings right from the app.
  • Server Configuration: (For Rucio-Admin Accounts) Manage server configurations with ease. Create, add, update, and delete config sections and options.

Usage

Connecting your Rucio Account

After you start the app for the first time, you'll need to connect your Rucio account to the app. Simply click on Add your Rucio account and setup a new account with your USERPASS or X509 credentials, and the server details.

After setting up the account, you'll be able to log into the app using that account.

Adding Multiple Rucio Accounts

You can also set up multiple Rucio Accounts on the app. Simply add more accounts from Add your Rucio account utility from the Login screen or once logged in, click go to Accounts and click on Add a New Account there. After adding the details log in to the app using any added account. The app will authenticate all the added accounts automatically.

For Detailed Instructions refer to our Usage Guide here.

Documentation

Contributing

If you are interested in contributing to this project to add features or make bug fixes, we would encourage you to have a look at our CONTRIBUTION GUIDE.

A huge thanks to all the contributors of Rucio Desktop!

Extra Notes

  • This project is under development as part of the Google Summer of Code 2020 project for CERN-HSF's Rucio.
  • It is not yet ready for production release.
  • This software is tested on Ubuntu 18.04 LTS.
  • Using the Explore feature in the app requires installation of FUSE-POSIX Interface on the system.

desktop's People

Contributors

viveknigam3003 avatar bari12 avatar

Stargazers

Shubham Agarwal avatar

Watchers

Mario Lassnig avatar Joaquin Bogado avatar  avatar James Cloos avatar  avatar Benedikt Ziemons avatar Yuyi Guo avatar Ian Johnson avatar Diego Ciangottini avatar Alexander Richards avatar Gabriele Fronzé avatar Mayank Sharma avatar Fabio Luchetti avatar Vincent Garonne avatar Aris Fkiaras avatar  avatar  avatar Riccardo Di Maio avatar

desktop's Issues

Add detailed API References.

Motivation

The application provides many API wrappers for the Rucio RESTFUL APIs which can be found here. Yet the API reference isn't complete.

Modification

Add the API reference for the API wrappers provided with this software in the developer documentation.

Add Contribution Guide

Motivation

A well-written contribution guide helps the community in understanding the patterns for contributing to the project. It is necessary to improve engagement among the community and lower the entry-barrier for the new-comers.

Modification

Add a contribution guide which resembles the one for the organisation.

Create a bundled package for Rucio Desktop.

Motivation

Current version of Rucio Desktop only works in Developer mode and no binaries are compiled for the software to be used on client machines.

Modification

Write build configurations and create binaries for target systems for public release.

Enhancement: Add unit tests for APIs

Motivation

To setup CI/CD workflows and ensure successful contributions without any hassle, a test suite is necessary for the whole application including UI and the server.

Modification

Add unit tests for UI components.

Expected Results

  • Unit test suite using Jest for the front-end components.

Handle path state on Explore unmount

Motivation

The path for Explorer is stored and accessed from the state tree which works fine when browsing the scoped namespace. BUT, the application does not handle unexpected unmount of the Explore tab component, which causes the app to crash.

Error Log:

Error: EIO: i/o error, stat '/ruciofs/rucio-server-x509/test/dataset3/rucio-server-x509'
[1]     at Object.statSync (fs.js:933:3)
[1]     at getFiles (/home/vivek/Desktop/GSoC_2020/desktop/server/APIs/files.js:23:10)
[1]     at /home/vivek/Desktop/GSoC_2020/desktop/server/routes/files.js:16:16
[1]     at Layer.handle [as handle_request] (/home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/layer.js:95:5)
[1]     at next (/home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/route.js:137:13)
[1]     at Route.dispatch (/home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/route.js:112:3)
[1]     at Layer.handle [as handle_request] (/home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/layer.js:95:5)
[1]     at /home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/index.js:281:22
[1]     at Function.process_params (/home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/index.js:335:12)
[1]     at next (/home/vivek/Desktop/GSoC_2020/desktop/node_modules/express/lib/router/index.js:275:10)

Modification

Fix the unmount handling by adding a cleaup effect for component unmount, and resets the path state on unmount.

Expected Results

  • The app handles unexpected clicking of any other tab.
  • Path state cleaned and reset on opening some other tab or selecting some other function.

Improve User documentation and Client Usage Guide

Motivation

The usage guide provided with the app in the user documentation is not self-sufficient and seems incomplete. There is also a large scope of improvement by adding more illustrations, GIFs, etc to help the users setup and use the application easily.

Modification

Improve the user documentation and usage guide for Rucio Desktop by adding more screenshots and GIFs with explanation to use the app and set it up for a first time user.
Contact @viveknigam3003 for more details on this issue.

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.