Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shivthakker authored Feb 26, 2024
1 parent f13b84c commit 735f267
Showing 1 changed file with 106 additions and 1 deletion.
107 changes: 106 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,111 @@
</p>
</p>

# Introduction:

Solid, an innovative technology developed by Sir Tim Berners-Lee, offers a groundbreaking approach to managing data by enabling decentralized data ownership and interoperability through Linked Data principles. In the realm of logistics, Solid presents a promising solution for revolutionizing supply chain management by facilitating seamless data sharing among stakeholders. This document outlines Solid's capabilities and requirements for implementing a logistics solution, along with a user needs assessment highlighting UI/UX changes necessary for optimal user experience.

## Solid's Capabilities for Logistics:

- **Decentralized Data Ownership:** Solid allows individual entities, such as companies and suppliers, to maintain ownership of their data while granting controlled access to authorized parties. This feature ensures data security and privacy, crucial aspects in logistics operations.

- **Linked Data Sharing:** Solid's ability to establish a knowledge graph facilitates interconnectedness among disparate data sources. This is particularly beneficial for supply chain management, as it enables holistic insights and transparency across the entire supply chain network.

- **Interoperability:** Solid promotes interoperability by standardizing data formats and protocols, enabling seamless communication and integration between different systems and platforms. This facilitates smooth data exchange between logistics partners and enhances operational efficiency.

- **Collaborative Workflows:** With Solid, logistics stakeholders can collaborate in real-time, share updates, and coordinate activities effectively. This fosters greater synergy and coordination within the supply chain ecosystem, leading to improved decision-making and responsiveness.

## Requirements for Logistics Solution on Solid:

- **Solid Compatibility:** Fleetbase must be compatible with Solid's architecture, ensuring seamless integration and data exchange within the Solid ecosystem.

- **Data Security and Privacy:** Robust mechanisms for data security and privacy protection must be implemented to safeguard sensitive logistics information shared through Solid.

- **Linked Data Integration:** Fleetbase should leverage Solid's linked data capabilities to establish a comprehensive knowledge graph that connects relevant supply chain data points, enabling advanced analytics and insights generation.

- **Interoperability Standards:** Adherence to interoperability standards and protocols endorsed by Solid is essential to ensure compatibility and smooth interoperability with other logistics systems and platforms.

- **User-Friendly Interface:** The solution should feature an intuitive user interface (UI) that simplifies data interaction and facilitates seamless navigation for logistics professionals across different roles and responsibilities.

## Project Milestones:

1. **Research and planning - Milestone 1**
- Produce a short document detailing Solid's capabilities and requirements for logistics solution, including a ‘user needs assessment’ which outlines the specific UI/UX changes that would be required in the subsequent milestones.

2. **Back End Development - Solid Server, Solid Auth, Create Pods - Milestone 2**
- Solid Server Integration Completed.
- Functional Solid Authentication mechanisms integrated into Fleetbase's existing authentication processes.
- Fleetbase users can create Pods, and the system supports secure data storage and sharing through these Pods.
- Push new release on [GitHub](https://github.com/fleetbase/solid).

3. **Back End Development - Pod for instance or Pod for Organization - Milestone 3**
- Develop and implement functionality for managing Pods specific to individual instances or organizations within the Fleetbase logistics platform.
- Implement secure data sharing mechanisms between Pods and logistics entities within Fleetbase.
- Push new release on [GitHub](https://github.com/fleetbase/solid).

4. **User Interface (UI) Enhancement - Manage Pod In Admin - Milestone 4**
- Design and implement an intuitive user interface (UI) for managing Pods within Fleetbase's administrative dashboard.
- Ensure seamless integration of Solid-related features into Fleetbase's existing administrative UI.
- Push new release on [GitHub](https://github.com/fleetbase/solid).

5. **Further User Interface (UI) Enhancement - Milestone 5**
- Identify and incorporate design elements and interactions specific to the new Solid features.
- Optimize the overall user experience for logistics professionals interacting with Fleetbase on Solid.
- Push new release on [GitHub](https://github.com/fleetbase/solid).

## User Needs Assessment: UI/UX Changes:

### Prerequisites:

- **Create Pod on Solid:** Begin by registering on Solid via [solidcommunity.net](https://solidcommunity.net).
- **Retrieve Web ID:** Obtain your Web ID from example: [shivthakker.solidcommunity.net](https://shivthakker.solidcommunity.net).
- **Ability to create pod using Fleetbase directly.**

### Installation and Setup:

- Install the ‘Solid Extension’ from Fleetbase Extensions Marketplace, accessible at the Instance Level.
- Add ‘Install Solid’ functionality within Fleetbase Extensions Tab.
- Create pod & server
- Input their server
- Input their solid ID on the server
- Once installed, users signing up or added to the company within this instance can utilize Solid for data management.

### User Authentication and Account Creation:

- Choose data storage preference: Browser Storage or Solid.
- Log in or sign up with your Solid Web ID.
- Authorize fleetbase.io to access your Pod.
- Solid allows precise control over data access permissions. Note: The current UI version (node-solid-server V5.1) supports toggling global access permissions only. If you prefer granular control, uncheck all boxes and authorize. Then, manage permissions explicitly.

### Features:

- Ability to link Fleetbase account with Solid Web ID later via user settings.
- View and manage data stored on Solid Pod:
- Orders
- Payload
- Entity
- Service Quote
- Purchase Rate
- Retrieve list of Solid Pods approved to receive data.
- Ability to add approved pods to send order data too (Verification Process)
- View order details
- Send order details
- Select Pod to send order details too
- Send order details to Solid partners:
- View Order
- Send Order
- Select from Dropdown of Solid Partners
- Confirmation popup for sending data
- Review and confirm data to be sent
- Access a separate table to view all data shared with you or shared with other Solid users.

# Conclusion:

Solid offers a robust foundation for developing innovative logistics solutions that prioritize data ownership, interoperability, and collaboration. By leveraging Solid's capabilities and addressing specific user needs through UI/UX enhancements, logistics stakeholders can unlock new levels of efficiency, transparency, and value creation in supply chain management.

This document serves as a roadmap for designing and implementing Solid on Fleetbase, guiding stakeholders towards harnessing the full potential of decentralized, linked data sharing in the logistics domain.


---

## Overview
Expand Down Expand Up @@ -122,4 +227,4 @@ pnpm build
See the Contributing Guide for details on how to contribute to this project.

## License
This project is licensed under the MIT License.
This project is licensed under the MIT License.

0 comments on commit 735f267

Please sign in to comment.