Skip to content

A web application for interacting with Solid Pods including data upload and management, data sharing, data privacy editing, [federated] data querying, and query results sharing (developed for the CHIST-ERA TRIPLE project).

License

Notifications You must be signed in to change notification settings

KNowledgeOnWebScale/solid-cockpit

Repository files navigation

Solid Cockpit Header Logo


Table of Contents

Solid Cockpit

This repository contains all code and guides for the Solid Cockpit web application. Solid Cockpit is an intuitive web application for accessing, editing, and interacting with Solid Pods.

This applicaiton was originally made for the CHIST-ERA TRIPLE project. For additional getting started guides and information about this project please see ... .

To use this App, you need to already have a Solid Pod!

Ways to Get a Solid Pod:

Contribute

Code contributions are welcome! Please commit any pull requests against the main branch.

Issue reporting and other general feedback are welcome. Please use GitHub Issues open an issue or GitHub Discussions where applicable.

Development Notes:

General issues:

  • If weird things start to happen with athn issues, clear browser history and cookies and it should fix things.

TO DO:

Data Upload:

  1. Fix UI and Color Scheme
  2. Functionality to edit existing RDF stored in Pod

Data Browser:

  1. Data display improvements
  2. Functionality to edit data (naming, metadata, etc.) and delete data

Data Query:

  1. Integrate (SPARQL-Editor)[https://github.com/sib-swiss/sparql-editor] for query input, editing, and results display
  2. Methods to observe past query SPARQL and Results
  3. Methods for searching through Query Cache (a search bar)
  4. Methods for "sharing" queries and results (i.e. privacy editing)
  5. Methods for deleting past queries and results

Data Privacy:

  1. Finish "SharedWithMe" and "SharedWithOthers" views
  2. Implement "notifications" view

TRIPLE Guide

👋 Welcome to the TRIPLE Getting Started Guide! This document will help you set up a Solid Pod and introduce you to the features of the Solid Cockpit app. Follow the steps carefully to get up and running 🚀

🎯 Objectives of This Guide

  1. Setting up a Solid Pod (that is accessible via the internet)
  2. Logging into your Pod at any time (after setting it up)
  3. Understanding the features and functionalities of the Solid Cockpit app.
  4. Overview of future capabilities, such as managing pod contents, adjusting data privacy, and querying data using SPARQL.

🌐 Setting Up a Solid Pod (Online)

To set up your Solid Pod using the TRIPLE platform, follow these steps:

  1. 🔗 Navigate to our Solid Pod Hosting website

  2. 🔐 Sign Up to make a Pod

    • Click Sign Up (assuming this is your first time)
  3. 🛠️ Create Your Solid Pod

    • Once you are on the Your Account page, click on Create Pod.
    • Enter a name for your new pod and click Create Pod.
    • After creating your pod, return to the home page by clicking Back.

🔑 Logging into your Solid Pod (after creation)

  1. Navigate to our Solid Pod Hosting website

  2. Login using your credentials

    • Click Login (assuming you have already made an account)
  3. Register your Pod on your new WebID card

    • Navigate to the "Home" page of the Solid-Cockpit Webpage
    • Login to your Solid Pod using the "https://triple.ilabt.imec.be/" provider
    • CLICK the "REGISTER POD" button (not necessary to enter any PodURL)
    • Thats it. Now you are connected to your new Pod!!

🛫 Using the Solid Cockpit App

The Solid Cockpit app provides several functionalities for managing and interacting with your Solid Pod.

✨ Available Features

  1. 📝 Data Upload

    • Upload data to your Pod.
    • When uploading RDF data, file validity can be assessed before uploading.
    • Specify and modify the metadata of uploaded files.
  2. 🗂️ Data Browser (under construction)

    • View, modify, move, and delete the contents of your Pod.
    • Explore and edit the container structure of your Pod.
  3. 🔍 Data Query

    • An editor to write SPARQL queries to interact with data in your Pod, the Pods of others, and SPARQL Endpoints.
    • A user input to designate the sources for the queries.
    • Options that impact the the output formats, query execution, and other relevant parameters.
  4. 🔒 Data Privacy Management

    • View the current privacy settings for your data (Read, Write, and Append).
    • Add or change privacy settings to containers and resources in your Pod.
    • Give and receive notifications related to new access rights to the data of others.

🔮 In the Near Future

  • Improve the functionality of the Pod Browser for displaying pod contents effectively.
  • Create interface for querying pod(s) (and SPARQL endpoints).
  • Integrate example query catalogue for the querying functionality.
  • Enhance privacy management display

Stay tuned for future updates that will bring more features and improvements to the Solid Cockpit app, making it more powerful and easier to use.

🤝 Support and Further Information

If you encounter issues during setup or usage, please consult our support resources or reach out to our support team for assistance.


🙏 We hope you find this guide helpful in setting up and exploring your Solid Pod. For questions or comments: go here. To report bugs or problems: try here.

Enjoy piloting your Pod with Solid Cockpit!

About

A web application for interacting with Solid Pods including data upload and management, data sharing, data privacy editing, [federated] data querying, and query results sharing (developed for the CHIST-ERA TRIPLE project).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published