Code Monkey home page Code Monkey logo

dataverse-portal's Introduction

axone github banner

       

Axone - Orchestration Layer for AI

lint build test codecov docker-pull discord conventional commits semantic-release Contributor Covenant license

Axone is a public dPoS layer 1 specifically designed for connecting, sharing, and monetizing any resources in the AI stack. It is an open network dedicated to collaborative AI workflow management that is universally compatible with any data, model, or infrastructure. Data, algorithms, storage, compute, APIs... Anything on-chain and off-chain can be shared.

The protocol

axoned is the node of the AXONE network built on the Cosmos SDK đŸ’« & Tendermint consensus, which allows companies & individuals to define on-chain rules, share any off-chain resources & create a new generation of applications on top of them.

Read more in the introduction blog post. For a high-level overview of the AXONE protocol and network economics, check out the white paper.

Want to become a validator?

Validators are responsible for securing the axone network. Validator responsibilities include maintaining a functional node with constant uptime and providing a sufficient amount of $AXONE as stake. In exchange for this service, validators receive block rewards and transaction fees.

Want to become a validator? 👉 Checkout the documentation!

Looking for a network to join ? 👉 Checkout the networks!

Supported platforms

The axoned blockchain currently supports the following builds:

Platform Arch Status
Darwin amd64 ✅
Darwin arm64 ✅
Linux amd64 ✅
Linux arm64 ✅
Windows amd64 ïžđŸš«
Not supported

Note: as the blockchain depends on CosmWasm/wasmvm, we only support the targets supported by this project.

Releases

All releases can be found here.

axoned follows the Semantic Versioning 2.0.0 to determine when and how the version changes, and we also apply the philosophical principles of release early - release often.

Install

From release

curl https://i.jpillora.com/axone-protocol/axoned! | bash

From source

make install

Using docker

docker run -ti --rm axoneprotocol/axoned --help

Developing & contributing

axoned is written in Go and built using Cosmos SDK. A number of smart contracts are also deployed on the AXONE blockchain and hosted in the axone-protocol/contracts project.

Prerequisites

  • install Go 1.21+ following instructions from the official Go documentation;
  • use gofumpt as formatter. You can integrate it in your favorite IDE following these instructions or invoke the makefile make format-go;
  • verify that Docker is properly installed and if not, follow the instructions for your environment;
  • verify that make is properly installed if you intend to use the provided Makefile.

Makefile

The project comes with a convenient Makefile that helps you to build, install, lint and test the project.

$ make <target>

Targets:
  Lint:
    lint                Lint all available linters
    lint-go             Lint go source code
    lint-proto          Lint proto files
  Format:
    format              Run all available formatters
    format-go           Format go files
    format-proto        Format proto files
  Build:
    build               Build all available artefacts (executable, docker image, etc.)
    build-go            Build node executable for the current environment (default build)
    build-go-all        Build node executables for all available environments
  Install:
    install             Install node executable
  Test:
    test                Pass all the tests
    test-go             Pass the test for the go source code
  Chain:
    chain-init          Initialize the blockchain with default settings.
    chain-start         Start the blockchain with existing configuration (see chain-init)
    chain-stop          Stop the blockchain
    chain-upgrade       Test the chain upgrade from the given FROM_VERSION to the given TO_VERSION
  Clean:
    clean               Remove all the files from the target folder
  Proto:
    proto               Generate all resources for proto files (go, doc, etc.)
    proto-format        Format Protobuf files
    proto-build         Build all Protobuf files
    proto-gen           Generate all the code from the Protobuf files
  Documentation:
    doc                 Generate all the documentation
    doc-proto           Generate the documentation from the Protobuf files
    doc-command         Generate markdown documentation for the command
  Mock:
    mock                Generate all the mocks (for tests)
  Release:
    release-assets      Generate release assets
  Help:
    help                Show this help.

This Makefile depends on docker. To install it, please follow the instructions:
- for macOS: https://docs.docker.com/docker-for-mac/install/
- for Windows: https://docs.docker.com/docker-for-windows/install/
- for Linux: https://docs.docker.com/engine/install/

Build

To build the axoned node, invoke the goal build of the Makefile:

make build

The binary will be generated under the folder target/dist.

Run a local network

To initialize a local network configuration, invoke the goal chain-init of the Makefile:

make chain-init

The node home directory will be generated under the folder target/deployment/localnet. The configuration contains a single validator node.

To start the network, invoke the goal chain-start of the Makefile:

make chain-start

A wallet is preconfigured with some tokens, you can use it as follows:

axoned --home target/deployment/localnet tx bank send validator [to_address] [amount]

Bug reports & feature requests

If you notice anything not behaving how you expected, if you would like to make a suggestion or would like to request a new feature, please open a new issue. We appreciate any help you're willing to give!

Don't hesitate to ask if you are having trouble setting up your project repository, creating your first branch or configuring your development environment. Mentors and maintainers are here to help!

Community

The AXONE Discord Server is our primary chat channel for the open-source community, software developers and node operators.

Please reach out to us and say hi 👋, we're happy to help there.

You want to get involved? 😍

So you want to contribute? Great! ❀ We appreciate any help you're willing to give. Don't hesitate to open issues and/or submit pull requests.

We believe that collaboration is key to the success of the AXONE project. Join our Community discussions on the Community Repository to:

  • Engage in conversations with peers and experts.
  • Share your insights and experiences with AXONE.
  • Learn from others and expand your knowledge of the protocol.

The Community Repository serves as a hub for discussions, questions, and knowledge-sharing related to AXONE. We encourage you to actively participate and contribute to the growth of our community.

Please check out AXONE health files:

dataverse-portal's People

Contributors

amimart avatar anjamis avatar bot-anik avatar ccamel avatar dependabot[bot] avatar erikssonjoakim avatar fredericvilcot avatar geoffreypicard avatar hleonardtek avatar jeremylgn avatar loiclaudet avatar lolottetheclash avatar mdechampg avatar oaitbaziz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

fredericvilcot

dataverse-portal's Issues

Feat: Large screen page content display

Feature: Large screen page content display

As a user of the portal,
I want to see unstreched page content
When I am displaying the app on a large screen
So that I enjoy my user experience better

Acceptance criteria

Scenario 1 : large screen

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a large desktop device,
When I am on any page
Then I should see the page content width limited and displayed on the left side of the screen

Resources

Mockups

What we have now:

Capture d’écran 2023-03-31 Ă  11 18 53

What we should have:

Capture d’écran 2023-03-31 Ă  11 19 12

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Catalog – Resource Filters

Feat : Catalog – Resource Filters

As a user of the portal,
I want to be able to filter by dataverse item (Dataspace // Dataset // Service)
So that I can have be more specific about what I'm looking for

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the dataverse page,
Then I should be able to use a filter that can be applied to the type of dataverse item (Data Space or Dataset or Service)

Scenario: mobile display

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the dataverse page,
And I use a mobile device
Then I should be able to see and interact with filters in a mobile-friendly way.

Scenario: Interacting with filters

Given that I am a user of the web portal (authenticated or unauthenticated),
When I click on all
Then All types of dataverse items should appear
When I click on Data Spaces
Then Only Data Spaces will appear
When I click on Datasets
Then Only Datasets will appear
When I click on Services
Then Only Services will appear
When I click on 2 types
Then Only cards of these two types will appear
When I deselect 1 specific type
Then all is selected automatically

Requirements

Mockups

Desktop :
image.png

Mobile :
image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : number of Data Spaces created

Feature: Number of Data Spaces created

As a user of the portal,
I want to see the total number of Data Spaces created in the Dataverse on the Home Page
So that I know that the Dataverse contains already several Data Spaces and I have information about the dynamism of the community

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Home Page
Then I should see the Number of Data Spaces created in the Dataverse (see mock up)

Scenario: theme switching

Given that I am a user of the web portal,
When I click the theme switcher button,
Then the theme of the entire portal should change to the alternate theme.
And the switcher button should visually reflect the currently selected theme.

Requirements

Until the catalog database is not ready, the fake data is : 2

Tech requirements

The card must displayed in a 12 columns grid.

Resources

Mockups

Desktop

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Resource Detail - general description

Feat : Resource Detail - general description

As a user of the portal,
I want to read a general description of a shared resource (data or service)
So that I can understand what this resource is about, its context of creation and its purpose.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
Then I should see the name of the resource, its label (type of the resource) and a general description (see mock up)

Scenario: mobile display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
And I use a mobile device
Then I should see the name of the resource, its label (type of the resource) and a general description (see mock up mobile device)

Scenario: Internationalization

Given thatI am a user of the web portal (authenticated or unauthenticated),
When the selected language is English
Then texts should be displayed in English language,
Data Space
Dataset
Service
And metadata of the resources should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Data Space
Données
Service
And metadata of the resources should be displayed in French

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
Datenraum
Datensatz
Dienstleistung
And metadata of the resources should be displayed in German

Requirements

Mockups

Desktop :
image.png

Mobile :
image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat: Data Space governance – Services Management Tabs

Feature: Data Space governance – Services Management Tabs

As a user of the Data Space,
I want to explore the different Services Management tabs
So that I read the terms and conditions of this section

Acceptance criteria

Scenario 1: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated) on the Data Space governance page,
And I am using a desktop device,
When I am on the Services Management section
Then I should see a proper description of the different tabs that appear as presented in the mockup below

Scenario 2: Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated),
And I use a mobile device
When I am on the Services Management section
Then I should a see mobile friendly display (See mock up)

Scenario 3: Change tab

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected tab is Reference, Modify or Dereference
Then the adequate selected tab should be displayed (See mock up)

Scenario 4: Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected language is English, French, or German
Then tab title should be displayed in the adequate selected language (See config)

En

Reference
Modify
Dereference

Fr

Référencer
Modifier
Déréférencer

De

Referenzieren
Bearbeiten
Auslisten

Requirements

  1. Default landing tab is Reference

Resources

Mockups

Desktop

image.png

Mobile

image.png

Environment

Additional informations

None.

Add environment variables

Purpose

The goal is to create a file containing the environment variables so that the application can access them and propagate them to all the pages of the site.

Feature: Action cards home page

Feature: Action cards home page

As a user of the portal authenticated or not,
I want to see the 4 Action Cards on the home page but disabled
So that I know the main actions I will be able to take to interact with OKP4 protocol when the related features will be deployed.

Acceptance criteria

Scenario: Default display

Given that I am user of OKP4 portal,
And I am authenticated or not
And I am using a desktop device,
When I am on the home page,
Then I should see the Action cards
When I hover the cards, I see the hover disable version (with Soon Available)
And the cards are not clickable

Scenario: Mobile display

Given that I am user of OKP4 portal,
And I am authenticated or not
And I am using a mobile device,
When I am on the home page,
Then I should see the Action cards on the disabled version
And the cards are not clickable

Scenario: Internationalization

Given that I am a user of the web portal on the catalog page,
When the selected language is English
Then texts should be displayed in English language,
Share Data & Services
Create Knowledge
Create Data Spaces
Build applications
Soon available

Given that I am a user of the web portal on the catalog page,
When the selected language is French
Then texts should be displayed in French language,
Partager des Données et Services
Créer des Connaissances
Créer des Data Spaces
Construire des Applications
BientĂŽt disponible

Given that I am a user of the web portal on the catalog page,
When the selected language is German
Then texts should be displayed in German language,
Daten & Dienste teilen
Wissen schaffen
Data-Spaces erstellen
Anwendungen erstellen
Bald verfĂŒgbar

Requirements

Resources

Mockups

Desktop

To complete

Mobile

To complete

Design system

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat: Application - Fixed toolbar and sidebar

Feature: Application - Fixed toolbar and sidebar

As a user of the portal,
I want to see every page with some scroll inside
So that I will be able to see all elements of the page with fixed sidebar and toolbar

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
And I use a desktop device
When I am on an application page (authenticated or unauthenticated)
Then I should see the sidebar content and the toolbar content whatever the level of scroll where I am

Requirements

This issue is easily testable on the Dataverse page, as it contains a large number of elements.
We must be able to scroll the whole page to see all the cards, the size of the sidebar is the same as the screen without scroll inside, and the toolbar remains visible.

Environment

Additional informations

None.

Feat : Governance description for a Data Space

Feature: Governance description for a Data Space

As a user of the portal,
I want to see a Data Space Governance description
So that I can quickly check out governance mainlines

Acceptance criteria

Scenario 1 : default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Data Space detail page
Then I should see a proper description for the resource governance (Data Space in this particular case) that appears as presented in the mockup below

Scenario 2 : Access governance button

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
Then the button 'See Governance' is disabled

Scenario 3 : Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on Data Space detail page
And I use a mobile device
Then I should see mobile friendly display (See mock up)

Scenario 4 : Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected language is English, French, or German
Thentitle, description and button should be displayed in the adequate selected language (See config)

Config example

As the dedicated service to fetch the Data Space governance description from the blockchain is not ready yet, here is the description for 2 Data Spaces:

DS4I Data Space

En

Governance (title)
DS4I is a private Data Space where resources are only accessible for a group of addresses contained in a dedicated whitelist.
Only OKP4 have the authority to edit the Whitelist. (description)
Access governance (button)

Fr

Gouvernance (title)
DS4I est un Data Space privĂ© oĂč les ressources ne sont accessibles que pour un groupe
d'adresses de wallets contenues dans une Whitelist dédiée.
Seul OKP4 a le droit de modifier cette whitelist. (description)
Accéder à la governance (button)

DE

FĂŒhrung (title)
DS4I ist ein privater Data Space, in dem die Ressourcen nur fĂŒr eine Gruppe zugĂ€nglich sind.
Adressen von Wallets, die in einer dedizierten Whitelist enthalten sind.
Nur OKP4 hat das Recht, diese Whitelist zu Àndern. (description)
Auf Governance zugreifen (button)

Rhizome

En

This first Data Space has a centralized governance: only OKP4 can modify the rules.
In this first version, only OKP4 can register data and services.
However, any wallet is allowed to download data.

Fr

Ce premier Data Space a une gouvernance centralisée : seul OKP4 peut modifier les rÚgles.
Dans cette premiÚre version, seul OKP4 peut enregistrer des données et des services.
Toutefois, n'importe quel wallet est autorisé à télécharger les données.

De

Dieser erste Data Space hat eine zentralisierte Governance: Nur OKP4 kann die Regeln Àndern.
In dieser ersten Version kann nur OKP4 Daten und Dienste speichern.
Allerdings ist es jeder Wallet erlaubt, Daten hochzuladen.

Resources

Mockups

Desktop.

image.png

Mobile

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : catalog grid content

Feature: Catalog grid content

As a user of the portal on the catalog
I want to see all the resources of the catalog
So that I can explore the dataverse

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
When I am on the catalog page (authenticated or unauthenticated)
Then I should see 20 cards of dataverse items displayed in a 4-column grid (see mock up) without any filter
And each card should be labelled according to the type (Data space, Dataset, Service)
And each card contains the title and the topic (for data spaces and datasets) or the category (for services)
And cards are sorted ‘by date of last update’
When I scroll down
Then the resources load 20 by 20 (infinite scroll, load as you go)

Scenario: Internationalization

Given that I am a user of the web portal on the catalog page,
When the selected language is English
Then metadata of the resources (title and category) should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then metadata of the resources (title and category) should be displayed in French if available or English by default

Given that I am a user of the web portal on the home page,
When the selected language is German
Then metadata of the resources (title and category) should be displayed in German if available or English by default

Requirements

The content should be fetched from the ontological database.

Resources

Mockups

Mock up :
image

Environment

Additional informations

None.

Enhancement : App - fix sidebar & toolbar

Feature: Enhancement : App - fix sidebar & toolbar

As a desktop, tablet and mobile user of the Portal,
I want to have easy access to the app sidebar & toolbar when navigating the application
So that I don't have to scroll through long pages to access the sidebar & toolbar

Acceptance criteria

Scenario: all displays

Given that I am a desktop, tablet and mobile user of the Portal,,
When when I scroll through a page in any navigation item,
Then the sidebar & toolbar should be fixed when I scroll down / up
So that I always have access to menus at any time and anywhere in the app

Requirements

This issue is easily testable on the Dataverse page, as it contains a large number of elements.
We must be able to scroll the whole page to see all the cards, the size of the sidebar is the same as the screen without scroll inside, and the toolbar remains visible.

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat: See details of a resource

Feature: See details of a resource

As a user of the portal on the catalog
I want to click on See details
So that I can have more information about a resource registered in the Dataverse

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal on the home page,
When I click on ‘See details’ button of a resource
Then I should be redirected to the resource details page of this resource (See requirements)
And I should see an arrow to go on Dataverse page

Requirements

The URL of the resource detail page should be with the framework :
Data space : /dataverse/dataspace/ID
Dataset : /dataverse/dataset/ID
Service : /dataverse/service/ID

Resources

Mockups

Mock up :
image.png

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Data Space Detail Page – topics

Feat : Data Space Detail Page – topics

As a user of the portal,
I want to check the topics related to one Data Space
So that I can quickly understand what this Data Space is about (topics covered by the Data Space)

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a Data Space,
Then I should see the related topics appear as presented in the mockup

Scenario: mobile display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a Data Space,
And I use a mobile device
Then I should see the related topics appears in a mobile friendly display

Scenario: Internationalization

Topics should appear correctly regarding the selected language.

EN

  • Agriculture, Food, environment and forestry.
  • Biology, geology, and chemistry
  • Industry, mobility, and engineering
  • Logistics, retail, supply chain, and eCommerce
  • DeFi and Crypto
  • Healthcare
  • Business and purchase
  • Marketing and Customer Behavior
  • Energy
  • Other

FR

  • Agriculture, alimentation, environnement et foresterie.
  • Biologie, gĂ©ologie et chimie
  • Industrie, mobilitĂ© et ingĂ©nierie
  • Logistique, commerce de dĂ©tail, chaĂźne d'approvisionnement et eCommerce
  • Crypto et finance dĂ©centralisĂ©e
  • Soins de santĂ©
  • Commerce et approvisionnement
  • Marketing et comportement des clients
  • Énergie
  • Autres

GR

  • Landwirtschaft, ErnĂ€hrung, Umwelt und Forstwirtschaft
  • Biologie, Geologie und Chemie
  • Industrie, MobilitĂ€t und Technik
  • Logistik, Einzelhandel, Lieferkette und eCommerce
  • DeFi und Krypto
  • Gesundheitswesen
  • Wirtschaft und Einkauf
  • Marketing und Kundenverhalten
  • Energie
  • Sonstiges

Technical Specifications

topics should be fetched from ontology

Requirements

Mockups

Desktop :
image.png

Mobile :
image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Home page catalog preview

Feature: Home page catalog preview ‘Explore’

As a user of the portal on the home page
I want to be able to see 4 resources of the dataverse
So that I see 4 interesting resources and it makes me want to discover more.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
When I am on the home page (authenticated or unauthenticated)
Then I should see 4 cards of dataverse’s resources (see mock up)
And I should see a Call To Action button “Explore the Catalog”

Scenario: See Details

Given that I am a user of the web portal on the home page,
Then I see the button "See Details" that are disabled

Scenario: Explore the catalog

Given that I am a user of the web portal on the home page,
When I click on ‘Explore the catalog’ button
Then I should be redirected to ‘/catalog’

Scenario: Internationalization

Given that I am a user of the web portal on the home page,
When the selected language is English
Then texts should be displayed in English language,
Explore
Data Space
Dataset
Service
See Details
Explore the catalog
And metadata of the resources should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Explorer
Data Space
Données
Service
Voir DĂ©tails
Explorer le catalogue
And metadata of the resources should be displayed in French

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
Erkunden Sie
Datenraum
Datensatz
Dienstleistung
Siehe Details
Den Katalog erforschen
And metadata of the resources should be displayed in German

Scenario: Mobile display

Given that I am a user of the web portal,
And I am using a mobile device
When I am on the home page
Then I should see the mobile version on the catalogue preview (See mock up 2)

Requirements

Faked data until we fetch them from the ontological database :

Card 1 :

  • Title : Rhizome
  • Category : Agriculture, Food, Environment and Forestry
  • Label : Data Space

Card 2 :

  • Title : Agreste 2020
  • Category : Agriculture, Food, Environment and Forestry
  • Label : Dataset

Card 3 :

  • Title : Graphical Plot Registry France 2020
  • Category : Agriculture, Food, Environment and Forestry
  • Label : Dataset

Card 4 :

  • Title : Data connector
  • Category : Data Integration
  • Label : Service

For the MVP, the displayed resources have the metadata “Portal display” = True

The URL of the resource detail page should be with the framework :
Data space : /dataverse/dataspace/ID
Dataset : /dataverse/dataset/ID
Service : /dataverse/service/ID

Resources

Mockups

Mock up :

Desktop :
image

Mobile :
image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat: Mobile display of Stat cards

Feature: Mobile display of Stat cards

As a user of the portal,
I want to get the portal app with mobile responsivity
So that I can use my mobile device to use the portal

Acceptance criteria

Scenario: mobile display

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a mobile device,
When I am on the Home Page
Then I should see the mobile version of the stat cards (see mock up)

Requirements

Resources

Mockups

Mobile

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Fix : Background when the lateral bar is open

Describe the bug

As a user of the portal with a mobile device,
When I open the lateral bar
The background (meaning the content of the page) is not well displayed : the text of the action cards go beyond the line of the card and the logo OKP4 overtakes on the lateral bar.

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'https://app.staging.okp4.network/ on a mobile phone
  2. Open the lateral bar
  3. See error on the tool bar and the action cards

Expected behavior

The content should be pushed by the lateral bar without changing it's size.

Screenshots

IMG_8433.PNG

IMG_8434.PNG

Smartphone (please complete the following information):

  • Device: iPhone 12
  • OS: iOS 16.3.1
  • Browser : safari

┆Issue is synchronized with this Wrike task by Unito

Chart & Data viz components

Propose a visual feature

Purpose

For the various web3 interfaces we are developing, we need to show data as charts or visual representations.

Visual

Here are 2 illustrations from @SpicySalm0n's current UI/UX work. These are subject to change, but give an interesting perspective to appreciate the expected requirements in terms of visualisation.

image

image

Here are some other illustrations taken from different sources:

image

image

Use cases

The use cases are very varied. It is a question of being able to visualise data sets of different kind according to different types of charts and representations (2D): evolution of the number of datasets created, evolution of token price...

Specification

The aim is to introduce in the Design System a set of 2D charting and data viz components that meet the following requirements (non exhaustive):

  • different kind of charts: bar, column, line, area, pie, treemaps, heatmaps, gauges, radar, candle stick...
  • suitable for both Web and mobile (responsive)
  • preferably with SVG rendering
  • performant (fast rendering)
  • interactive (pan, zoom, click...)
  • animatable
  • highly customizable (theme)
  • lightweight

Typology

TBD

Notes

As the implementation of charting components is beyond the functional core of the Design System, it is considered here to study the existing javascript chart libraries to rely on, compatible with our non-functionnal requirements (technology - React, license: open source).

Here's the list of the considered libraries:

┆Issue is synchronized with this Wrike task by Unito

Feature: internationalization

Feature: Internationalization

As a user of the portal,
I want to see English texts for the lateral bar
So that it allows me to navigate through the app in my favorite language

Acceptance criteria

Scenario: lateral bar translations

Given that I am a user of the web portal,
When I access any page of the portal,
Then The lateral bar texts should be displayed in English language,
Given that I am a user of the web portal,
When I expand the lateral bar,
Then navigation items must be displayed in english:
General
Home
Explore
My Data Spaces
Interact
Share Data & Services
Create Knowledge
Create Data Spaces
Build Applications
Learn
Documentation
Help Center
Given that I am a user of the web portal,
When I expand the lateral bar,
Then footer items must be displayed in english:
Give us feedback
About OKP4

Scenario: work in progress page translations

Given that I am a user of the web portal,
When I click on any navigation item
Then a work in progress page is displayed
And that displays English texts:
Work In Progress
We are working hard to unleash the Dataverse, stay tuned! 🚀

┆Issue is synchronized with this Wrike task by Unito

Feat : remove My Data Spaces from lateral bar

Feature: remove My Data Spaces from lateral bar

As a user on the portal,
I want to be prevented from clicking on the features that I can't access because I am not authenticated
So that I am not disappointed

Acceptance criteria

Scenario: Default display

Given that I am a user of the portal unauthenticated,
And I am using any device,
When I am on any page of the portal,
Then the button My Data Spaces should not appear

Requirements

Resources

Mockups

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Language switcher

As a user of the portal who can speaks multiple languages,
I want to be able to switch between languages on the interface
So that I can understand the content and use the application effectively in my preferred language.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
When I visit the application,
Then I should find the language switcher button at the bottom of the lateral bar (see mock up 1) either the bar is expansed or not,
And the button should display the current selected language,
And the button should be visible with light and dark themes.

Scenario: Open language menu

Given that I am a user of the web portal,
When I click on the language switcher button
Then a dropup menu should appear (see mock up 2)
And I should be able to select my preferred language from the list of available languages.

Scenario: Choose language

Given that I am a user of the web portal,
When I select in the menu my preferred language
Then the interface should immediately update all content and labels to the new language including all text, icons and buttons
And the language switcher button (at the bottom of lateral bar) should show the selected language
And the selected language is persisted in the browser for the next session.

Scenario: Close language menu

Given that I am a user of the web portal,
And The language menu is open
When I click outside the menu
Then the menu closes.

Scenario: Default language

Given that I am a user of the web portal,
When there is no preferred language in memory from the last session,
Then the selected language is the same as the navigator
When the navigator’s language is not available,
Then the default language is ‘English’

Requirements

None.

Resources

Link to the translations files : to complete

Mockups

Mock up 1 :
image.png

Mock up 2 :
image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : General description for a Dataspace

Feature: General description for a Data Space

As a user of the portal,
I want to see a Data Space description
So that I can check out the purpose of the Data Space before joining it.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Data Space detail page
Then I should see the title of the Data Space, its label (Data Space) and a proper description that appear as presented in the mockup below

Scenario : Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on a Data Space detail page
And I use a mobile device
Then I should see mobile friendly display (See mock up)

Scenario : Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected language is English, French, or German
Then the metadata should be displayed in the adequate selected language (See config)

Resources

Ontology examples : https://github.com/okp4/ontology/tree/main/example/rhizome

Mockups

Desktop.

image.png

Mobile

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Stat card home page - Internationalization

Feature: Internationalization of the statistic cards on the portal Home Page

As a user of the portal,
I want to read the statistic cards in English, French and German
So that I understand

Acceptance criteria

Scenario: translation

Given that I am a user of the web portal,
When I am on the Home Page
And the selected language is English
Then texts should be displayed in English language,
The community
Number of participants to OKP4 ecosystem
Data Spaces created
Datasets shared
Services shared

Given that I am a user of the web portal,
When I am on the Home Page
And the selected language is French
Then texts should be displayed in French language,
La communauté
Nombre de participants Ă  l'Ă©cosystĂšme OKP4
Data Spaces créés
Jeux de données partagés
Services partagés

Given that I am a user of the web portal,
When I am on the Home Page
And the selected language is German
Then texts should be displayed in German language,
Die Gemeinschaft
Anzahl der Teilnehmer am OKP4-Ökosystem
Erstellte Data Spaces
Geteilte DatensÀtze
Geteilte Dienste

Requirements

Resources

Mockups

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Data Space Detail Page – tags

Feat : Data Space Detail Page – tags

As a user of the portal,
I want to check Sata Space related tags
So that I can quickly understand what this Data Space is about

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a Data Space,
Then I should see the related tags appear as presented in the mockup

Scenario: mobile display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a Data Space,
And I use a mobile device
Then I should see the related tags appear in a mobile friendly display

Technical Specifications

Tags should be fetched from ontology
Tags can contain text on 2 lines maximum, with an ellipsis in case of longer text (same behavior as Chips)

Requirements

Mockups

Desktop :
image.png

Mobile :
image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Number of Services created

Feature: Number of Services created

As a user of the portal,
I want to see the total number of Services created in the Dataverse on the Home Page
So that I know that the Dataverse contains already several shared services and I have information about the dynamism of the community

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Home Page
Then I should see the Number of services shared in the Dataverse (see mock up)

Scenario: theme switching

Given that I am a user of the web portal,
When I click the theme switcher button,
Then the theme of the entire portal should change to the alternate theme.
And the switcher button should visually reflect the currently selected theme.

Requirements

Until the catalog database is not ready, the fake data is : 5

Tech requirements

The card must displayed in a 12 columns grid.

Resources

Mockups

Desktop

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feature: Connect wallet

Feature: Connect wallet

As a user of the portal,
I want to have a connect my wallet button in the toolbar at the top of the screen
So that it allows me to quickly connect my wallet

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
And I am using a desktop device,
When I access any page of the portal,
Then I should see a connect my wallet button in the toolbar
And should be thematized regarding the selected theme
And should do nothing for now when I click on the connect my wallet button.

┆Issue is synchronized with this Wrike task by Unito

Internationalization lateral bar

Feature: Internationalization of the lateral bar

As a user of the portal,
I want to be able to read the lateral bar in English, French and German
So that I can navigate through the app in my favorite language

Acceptance criteria

Scenario: lateral bar translations

Given that I am a user of the web portal,
And* the selected language is English
When I access any page of the portal,
Then The lateral bar texts should be displayed in English language,
Given that I am a user of the web portal,
When I expand the lateral bar,
Then navigation items must be displayed in english:
General
Home
Explore
My Data Spaces
Interact
Share Data & Services
Create Knowledge
Create Data Spaces
Build Applications
Learn
Documentation
Help Center
Given that I am a user of the web portal,
When I expand the lateral bar,
Then footer items must be displayed in english:
Give us feedback
About OKP4

Given that I am a user of the web portal,
And* the selected language is French
When I access any page of the portal,
Then The lateral bar texts should be displayed in French language,
Given that I am a user of the web portal,
When I expand the lateral bar,
Then navigation items must be displayed in French :
Général
Accueil
Explorer
Mes Data Spaces
Interagir
Partager des Données & Services
Créer des Connaissances
Créer des Data Spaces
Construire des Applications
Apprendre
Documentation
Centre d'aide
Given that I am a user of the web portal,
When I expand the lateral bar,
Then footer items must be displayed in english:
Donnez-nous votre avis
A propos de OKP4

Given that I am a user of the web portal,
And* the selected language is German
When I access any page of the portal,
Then The lateral bar texts should be displayed in German language,
Given that I am a user of the web portal,
When I expand the lateral bar,
Then navigation items must be displayed in German:
Allgemein
Startseite
Erkunden
Meine Data-Spaces
Interagieren
Daten & Dienste teilen
Wissen schaffen
Data-Spaces erstellen
Anwendungen erstellen
Lernen
Dokumentation
Hilfe-Center
Given that I am a user of the web portal,
When I expand the lateral bar,
Then footer items must be displayed in German:
Geben Sie uns Feedback
Über OKP4

Scenario: work in progress page translations

Given that I am a user of the web portal,
And the selected language is English
When I click on any navigation item
Then a work in progress page is displayed
And that displays English texts:
Work In Progress
We are working hard to unleash the Dataverse, stay tuned! 🚀

Given that I am a user of the web portal,
And* the selected language is French
When I click on any navigation item
Then a work in progress page is displayed
And that displays French texts:
Construction en cours
Nous travaillons dur pour lancer le Dataverse, restez Ă  l'Ă©coute ! 🚀

Given that I am a user of the web portal,
And* the selected language is German
When I click on any navigation item
Then a work in progress page is displayed
And that displays German texts:
Laufende Arbeiten
Wir arbeiten hart daran, das Dataverse freizugeben, bleiben Sie dran! 🚀

Requirements

Resources

Mockups

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feature: Lateral bar

Feature: Lateral bar

As a user of the portal,
I want to have a collapsible lateral bar on the left-hand side of the screen that contains navigation links and social network links, as well as a switcher for dark/light mode
So that it allows me to quickly access important information and easily switch between different themes.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
And I am using a desktop device,
When I access any page of the portal,
Then The lateral bar should be expanded on the left-hand side of the screen,
And should display navigation links to various sections of the portal (see mockup), social media links, and a button for sending feedback.
And should have the light theme selected.

Scenario: collapse/expand

Given that I am a user of the web portal,
When I click the collapse icon on the expanded lateral bar,
Then the lateral bar should collapse and hide the navigation links and social network links, making more space available for the content area of the page (see mockup).
When I click the collapse icon of the collapsed lateral bar,
Then the lateral bar should expand on the left-hand side of the screen
And should display navigation links to various sections of the portal (see mockup), social media links, and a button for sending feedback.
And the lateral bar state (collapsed / expanded) is persisted in the browser for the next session.

Scenario: theme switching

Given that I am a user of the web portal,
When I click the theme switcher button,
Then the theme of the entire portal should change to the alternate theme.
And the switcher button should visually reflect the currently selected theme.
And the theme is persisted in the browser for the next session.

Scenario: links

Given that I am a user of the web portal,
When I click on the link: Home,
Then the portal should navigate to / and display a Work In Progress page
When I click on the link: Explore,
Then the portal should navigate to /catalog and display a Work In Progress page
When I click on the link: My Data Spaces,
Then the portal should navigate to /dataspace and display a Work In Progress page
When I click on the link: Share Data & Services,
Then the portal should navigate to /sharing and display a Work In Progress page
When I click on the link: Create Knowledge,
Then the portal should navigate to /knowledge-builder and display a Work In Progress page
When I click on the link: Create Dataspace,
Then the portal should navigate to /dataspace-builder and display a Work In Progress page
When I click on the link: Build Applications,
Then the portal should navigate to /app-builder and display a Work In Progress page
When I click on the link: Documentation,
Then the portal should navigate to /documentation and display a Work In Progress page
When I click on the link: Help Center,
Then the portal should navigate to /help and display a Work In Progress page
When I click on the Twitter icon,
Then the portal should open https://twitter.com/OKP4_Protocol in another tab.
When I click on the LinkedIn icon,
Then the portal should open https://www.linkedin.com/company/okp4-open-knowledge-platform-for in another tab.
When I click on the Discord icon,
Then the portal should open https://discord.com/invite/okp4 in another tab.
When I click on the Medium icon,
Then the portal should open https://blog.okp4.network/ in another tab.
When I click on the About OKP4 link,
Then the portal should open https://okp4.network in another tab.
When I click on the Give us feedback link,
Then the portal should open to https://okp4.typeform.com/to/TNyFBH72 in another tab.

Requirements

None.

Resources

Mockups

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Resource Details - general display

Feat : Resource Details - general display

As a user of the portal,
I want to see the elements of the page displayed with the same layout (whether it is a dataset, data space or service), in a precise order according to the type of screen used
So that I can have a consistent and enjoyable user experience.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
When I am on the detail page of a resource (dataset, data space or service),
Then I should see a part of the details on the left half of the screen, and the other part on the right half of the screen.

Scenario: mobile and tablet display

Given that I am a user of the web portal,
When I am on the detail page of a resource (dataset, data space or service),
Then I should see first the details part which was on the left half of the desktop screen, and then, below it, the part which was on the right side of the desktop screen.

Requirements

  1. Desktop and large desktop: 12 columns divided in two parts.
  2. Tablet: 8 columns : first we can see the elements which were positioned on desktop left side, and below we can see the elements which were positioned on the desktop right side.
  3. Mobile: 6 columns : same logic as tablet.

The grid layout must be generic to fit data space, dataset and service layout

The URL of the resource detail page should be with the framework :
Data space : /dataverse/dataspace/ID
Dataset : /dataverse/dataset/ID
Service : /dataverse/service/ID

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Mobile display of lateral bar

Feature: Mobile display of lateral bar

As a user of the portal,
I want to get the portal app and its lateral bar with mobile responsivity
So that I can use my mobile device to use the portal

Acceptance criteria

Scenario: mobile display

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a mobile device,
When I am on any page of the portal
Then I should see a burger menu (see mock up 1)

Scenario: Open lateral bar

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a mobile device,
When I click on the burger menu
Then The lateral bar should open (See mock up 2) from the left to the right pushing the page towards the right.

Scenario: Close lateral bar

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a mobile device,
And the lateral bar is open
When I click on the cross
Then The lateral bar should close (See mock up 2), retracting to the left, pushed by the content of the page

Requirements

Resources

Mockups

1/
image

2/
image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat: Data Space governance – Business Model Tabs

Feature: Data Space governance – Business Model Tabs

As a user of the Data Space,
I want to explore the different Business Model tabs
So that I read the terms and conditions of this section

Acceptance criteria

Scenario 1: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated) on the Data Space governance page,
And I am using a desktop device,
When I am on the Business Model section
Then I should see a proper description of the different tabs that appear as presented in the mockup below

Scenario 2: Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated),
And I use a mobile device
When I am on the Business Model section
Then I should see mobile friendly display (See mock up)

Scenario 3: Change tab

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected tab is Datasets or Services
Then the adequate selected tab should be displayed (See mock up)

Scenario 4: Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected language is English, French, or German
Then tab title should be displayed in the adequate selected language (See config)

En

Datasets
Services

Fr

Jeux de données
Services

De

DatensÀtze
Dienste

Requirements

  1. Default landing tab is Datasets

Resources

Mockups

Desktop

image.png

Mobile

image.png

Environment

Additional informations

None.

Feat: number of Datasets shared

Feature: Number of Datasets created

As a user of the portal,
I want to see the total number of Datasets created in the Dataverse on the Home Page
So that I know that the Dataverse contains already several Datasets and I have information about the dynamism of the community

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Home Page
Then I should see the Number of Datasets created in the Dataverse (see mock up)

Scenario: theme switching

Given that I am a user of the web portal,
When I click the theme switcher button,
Then the theme of the entire portal should change to the alternate theme.
And the switcher button should visually reflect the currently selected theme.

Requirements

Until the catalog database is not ready, the fake data is : 18

Tech requirements

The card must displayed in a 12 columns grid.

Resources

Mockups

Desktop

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Internationalization toolbar

Feature: Internationalization of the toolbar

As a user of the portal,
I want to be able to read the lateral bar in English, French and German
So that I can navigate through the app in my favorite language

Acceptance criteria

Scenario: toolbar translations

Given that I am a user of the web portal,
And* the selected language is English
When I access any page of the portal,
Then The tool bar texts should be displayed in English language,
Connect my wallet

Given that I am a user of the web portal,
And* the selected language is French
When I access any page of the portal,
Then The tool bar texts should be displayed in French language,
Connecter mon portefeuille

Given that I am a user of the web portal,
And* the selected language is German
When I access any page of the portal,
Then The lateral bar texts should be displayed in German language,
Meine Brieftasche verbinden

┆Issue is synchronized with this Wrike task by Unito

Feat: details Page - General Metadata and audit metadata

Feature: details page - General Metadata and audit metadata

As a user of the portal,
I want to read general and audit metadata of a Dataverse item
So that I can understand better what is the item and its properties.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a dataverse item,
And I use a desktop device
Then I should see the general and audit metadata of the item (See mock up)

For each resource a specific list of properties is to be displayed.

Service Service Description Service Type
Core Metadata
Identifier A decentralized identifier URI is a URI that identifies a subject in a decentralized system and is managed independently of any centralized registry. anyURI
Registrar References the individual, company, or organization that is responsible for registering and managing a resource. DIDURI
General Metadata
Category A category of the resource. Concept
Publisher An entity primarily responsible for making the resource available. string
Tag A keyword or term assigned to the resource. string
Title A name given to the resource. string
Description A human-readable description of the resource. string
Audit Metadata
Created on The date and time when the resource was created. dateTime
Created by The entity who created the resource. DIDURI
Last modified on The date and time when the resource was last modified. dateTime
Last modified by The entity who last modified the resource. DIDURI
Dataset Dataset Description Dataset Type
Core Metadata
Identifier A decentralized identifier URI is a URI that identifies a subject in a decentralized system and is managed independently of any centralized registry. anyURI
Registrar References the individual, company, or organization that is responsible for registering and managing a resource. DIDURI
Provided by References the entity that provides the resource. anyURI
General Metadata
Publisher An entity primarily responsible for making the resource available. string
Creator An entity primarily responsible for making the resource. string
Tag A keyword or term assigned to the resource. string
Title A name given to the resource. string
Description A human-readable description of the resource. string
Spatial coverage The spatial applicability of the resource. Concept
License A legal document giving official permission to do something with the resource. Concept
Topic A topic of the resource. Concept
Format The format of the resource. Concept
Temporal coverage The temporal applicability of the resource. Period
Audit Metadata
Created on The date and time when the resource was created. dateTime
Created by The entity who created the resource. DIDURI
Last modified on The date and time when the resource was last modified. dateTime
Last modified by The entity who last modified the resource. DIDURI
Zone Zone Description Zone Type
Core Metadata
Identifier A decentralized identifier URI is a URI that identifies a subject in a decentralized system and is managed independently of any centralized registry. anyURI
Registrar References the individual, company, or organization that is responsible for registering and managing a resource. DIDURI
General Metadata
Publisher An entity primarily responsible for making the resource available. string
Tag A keyword or term assigned to the resource. string
Title A name given to the resource. string
Description A human-readable description of the resource. string
Topic A topic of the resource. Concept
Audit Metadata
Created on The date and time when the resource was created. dateTime
Created by The entity who created the resource. DIDURI
Last modified on The date and time when the resource was last modified. dateTime
Last modified by The entity who last modified the resource. DIDURI

Scenario: mobile display

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a dataverse item,
And I use a mobile device
Then I should see the general metadata of the item on its mobile version (See mock up)
See previous table for the properties to display

Scenario : Copy DID

Given that I am on the Detail Page of a dataverse item,
When I click on the logo located next to a DID (public key),
Then the DID is copied in the clipboard
And a toast appears with copied and a tick

Scenario: Internationalization

Given thatI am a user of the web portal (authenticated or unauthenticated),
When the selected language is English
Then texts should be displayed in English language,
Publisher
Registrar
Provided by
Belong to
Unique ID
Metadata created by
Metadata created on
Metadata last modified by
Metadata last modified on
Copy

And metadata of the resources should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Éditeur
Enregistré par
Fourni par
Appartient Ă 
ID unique
Métadonnées créées par
Métadonnées créées le
DerniÚre modification des métadonnées par
DerniÚre modification des métadonnées le
Copié
And metadata of the resources should be displayed in French

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
Verleger
Registrar
Bereitgestellt von
Zugehörig zu
Einzigartige ID
Metadaten erstellt von
Metadaten erstellt am
Metadaten zuletzt geÀndert von
Metadaten zuletzt geÀndert am
Kopiert
And metadata of the resources should be displayed in German

Requirements

Resources

Mockups

Desktop

Data Space

Dataset

Service

Mobile

Data Space

Dataset

Service (without provided by -> Mock up to be updated)

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Resource Detail - General metadata

Feat : Resource Detail - General metadata

As a user of the portal,
I want to read general metadata of a shared resource (data or service)
So that I can understand better what is the resource and its properties.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
Then I should see the general metadata of the resources (See mock up)

Scenario: mobile display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
And I use a mobile device
Then I should see the general metadata of the resources on its mobile version (See mock up)

Scenario : Temporal Coverage

Given that I am a user of the web portal (authenticated or unauthenticated) on the detail page of a resource
When the metadata Start date and End dateare fulfilled in the ontology,
Then I should see Year of Start Date - Year of End Date (Mock up 1)
When the metadata Start date is fulfilled in the ontology and End Date is missing
Then I should see From Year of Start Date (Mock up 2)
When the metadata End date is fulfilled in the ontology and Start Date is missing
Then I should see To Year of End Date (Mock up 3)
When Start date and End date are missing
Then Temporal Coverage is not displayed at all

Scenario: Internationalization

Given thatI am a user of the web portal (authenticated or unauthenticated),
When the selected language is English
Then texts should be displayed in English language,
Format
Topic
Licence
Geographical coverage
Temporal coverage
And metadata of the resources should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Format
Domaine
Licence
Couverture géographique
Couverture temporelle
And metadata of the resources should be displayed in French

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
Format
Thema
Lizenz
Geografischer Geltungsbereich
Zeitlicher Geltungsbereich
And metadata of the resources should be displayed in German

Requirements

Mockups

Desktop :

Dataset :
1/
image

2/
image

3/
image

Service
image

Mobile :

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

[Governance] - main sections

Feature: Data Space governance - main sections

As a user of the Data Space,
I want to see all the sections of the governance rules,
So that I understand the terms and conditions of the Data Space

Acceptance criteria

Scenario 1: Default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Data Space Governance page
Then I should see the title of the Data Space
And I should see the different section titles that appear as presented in the mockup below
new And the first section (and its first subsection if available) is selected and displayed on the right hand side following scenario 3

Scenario 2: Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the Data Space governance page
And I use a mobile device
Then I should see mobile friendly display (See mock up)

Scenario 3: Selected section

Given that I am a user of the web portal (authenticated or unauthenticated),
And I am on the Data Space governance page
edited When a section (or subsection if available) is selected
Then the selected section should be displayed with its title (See mock up)
new And if available the title of the subsection as a subtitle

Scenario 4: Section WITH subsection

new
Given that I am a user of the web portal (authenticated or unauthenticated),
And I am on the Data Space governance page
When I select a section having subsections
Then the subsections are displayed on the sidebar following the tree hierarchy
And all those subsections are related to the section with a thin line (see mockup)
And by default the first subsection is selected to be displayed on the right hand side of the page following scenario 3

Scenario 5: Section WITHOUT subsection

new
Given that I am a user of the web portal (authenticated or unauthenticated),
And I am on the Data Space governance page
When I select a section that doesn't have any sub-section
Then the section is displayed on the right hand side of the page following the scenario 3

Scenario 6: Ordering section and subsection

new
Given that I am a user of the web portal (authenticated or unauthenticated),
And I am on the Data Space governance page
Then I see that the sections (and subsections if available for a section) are ordered following the order of the numbers defined for the item in the ontology
For more detail about ordering items please read this PR : axone-protocol/ontology#108

Scenario 7: Routing

new
Given that I am a user of the web portal (authenticated or unauthenticated),
When I use the browser search bar and enter ..dataspace/id/gouvernance
Then I should land on the URL of the first section (and first subsection if available) of the dataspace's gouvernance I entered in the initial URL

Scenario 8: Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected language is English, French, or German
Then sections title should be displayed in the adequate selected language

Config example

En edited

Governance

Identity Management

Governance Model

  • Create rules
  • Edit rules
  • Remove rules

Datasets Management

  • Reference dataset
  • Create metadata
  • Edit metadata
  • Remove metadata
  • Dereference dataset
  • Download dataset

Services Management

  • Reference service
  • Create service metadata
  • Edit service metadata
  • Remove service metadata
  • Dereference service

Business Model

  • Dataset retribution
  • Service retribution

Fr edited

Gouvernance

Gestion des Identités

ModĂšle de Gouvernance

  • CrĂ©er des rĂšgles
  • Mettre Ă  jour les rĂšgles
  • Supprimer des rĂšgles

Gestion des Jeux de Données

  • RĂ©fĂ©rencement du jeu donnĂ©es
  • CrĂ©er des mĂ©tadonnĂ©es
  • Supprimer des mĂ©tadonnĂ©es
  • DĂ©rĂ©fĂ©rencer le jeu de donnĂ©es
  • TĂ©lĂ©charger le jeu de donnĂ©es

Gestion des Services

  • RĂ©fĂ©rencement du jeu de donnĂ©es
  • CrĂ©er des mĂ©tadonnĂ©es
  • Supprimer les mĂ©tadonnĂ©es
  • DĂ©rĂ©fĂ©rencer le jeu de donnĂ©es

Modùle Économique

  • RĂ©tribution du jeu des donnĂ©es
  • RĂ©tribution des services

Gr edited

Governance

Verwaltung von IdentitÀten

Modell der Governance

Verwaltung von DatensÀtzen

  • Referenzdatensatz
  • Metadaten erstellen
  • Metadaten löschen
  • Dataset dereferenzieren
  • Datensatz herunterladen

Verwaltung von Dienstleistungen

  • Referenzdatensatz
  • Metadaten erstellen
  • Metadaten löschen
  • Dataset dereferenzieren

Wirtschaftliches Modell

  • Dataset-Retribution
  • DienstvergĂŒtung

Requirements

  1. Default landing section is Identity Management

Resources

Mockups

Desktop

image.png

Mobile

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Service card - number of service & update

Feature: Services card - number of Services & update

As a user on the portal, unauthenticated or not
I want to know the number of Services, and the last deposit (update) in a particular data space
So that I can know the "size" of the data space in terms of Service resources, and how often it is updated

Acceptance criteria

Scenario: Default display

Given that I am a user of the portal
And I am using any device,
When I am on data space page
Then number of Services, and last deposit should appear as presented in the mockup

Scenario : Internationalization

Given that I am a user of the web portal on a Data Space details page,
When the selected language is English
Then texts should be displayed in English language,
Services
Last update
And the date should be displayed like : Oct 29 2022

Given that I am a user of the web portal on a Data Space details page,
When the selected language is French
Then texts should be displayed in French language,
Services
DerniĂšre mise Ă  jour
And the date should be displayed like : 29 Oct 2022

Given that I am a user of the web portal on a Data Space details page,
When the selected language is German
Then texts should be displayed in German language,
Dienste
Letzte Aktualisierung
And the date should be displayed like : 29 Okt 2022

Technical specifications

Evolution of the component : please note that 2 buttons will be integrated in this card. You can see the mock up on the Figma.

Number of datasets
Number if datasets should be fetched from ontology

Last update
Last Update value (as date) should be fetched from ontology

Config 1 : Number of Services

While ontology is in progress, Services number are :

  • Rhizome : 7
  • DS4I : 1

Config 2 : Last update

While ontology is in progress, last deposit is

  • DS4I : 02/04/2023
  • Rhizome : 31/03/2023

Resources

Mockups

Desktop
image.png

Mobile

image.png

┆Issue is synchronized with this Wrike task by Unito

Feat : lateral bar partly disabled

Feature: lateral bar disabled

As a user on the portal,
I want to be prevented from clicking on the features that are not developed yet
So that I understand that it's not available yet

Acceptance criteria

Scenario: Default display

Given that I am a user of the portal,
And I am using a desktop device,
When I am on any page of the portal,
Then the following buttons of the lateral bar are disabled :

  • Share Data and Service
  • Create knowledge
  • Create Data Space
  • Build applications
  • Documentations
  • Help center
    And when I hover these buttons the mouse doesn't change in a hand and the color stays grey
    And I see "Alpha version" at the bottom of the lateral bar (not clickable)

Scenario: Mobile display

Given that I am a user of the portal,
And I am using a mobile device,
When I am on any page of the portal,
Then the following buttons of the lateral bar are disabled (color grey)

  • Share Data and Service
  • Create knowledge
  • Create Data Space
  • Build applications
  • Documentations
  • Help center
    And I can't click on them.
    And I see "Alpha version" at the bottom of the lateral bar (not clickable)

Requirements

Resources

Mockups

image

See design system
image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Mobile display of tool bar

Feature: Mobile display of tool bar

As a user of the portal,
I want to get the portal app and its tool bar with mobile responsivity
So that I can use my mobile device to use the portal

Acceptance criteria

Scenario: mobile display - unauthenticated and authenticated

Given that I am a user of the web portal,
And I am using a mobile device,
When I am on any page of the portal
Then I should see tool bar on its mobile version (see mock up)

Requirements

Resources

Mockups

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Catalog grid

Feature: Catalog grid

As a user of the portal on the catalog
I want to see a grid of cards
So that I will be able to see the resources of the catalog

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal,
And I use a desktop device
When I am on the catalog page (authenticated or unauthenticated)
Then I should see 20 cards of dataverse’s resources displayed in a 4-column grid without any filter
And each card should be labelled according to the resource type (Data space, Dataset, Service)

Scenario: See Details

Given that I am a user of the web portal,
When I am on the catalog page
Then the buttons "See details" are disabled

Scenario: long title and long category

Given that I am a user of the web portal on the catalog,
When the title of a resource is too long
Then it should be displayed on 1 line with ... at the end
When the category of a resource is too long
Then it should be displayed on 2 lines maximum with ... at the end

Scenario: mobile and tablet display

Given that I am a user of the web portal,
When I am on the catalog page (authenticated or unauthenticated)
And I use a tablet or mobile device
Then I should see 20 cards of dataverse’s resources displayed in a 2-column grid (tablet) or 1-column grid (mobile) (see mock up) without any filter
And each card should be labelled according to the resource type (Data space, Dataset, Service)

Scenario: Internationalization

Given that I am a user of the web portal on the catalog page,
When the selected language is English
Then texts should be displayed in English language,
Explore
Data Space
Dataset
Service
See Details

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Explorer
Data Space
Données
Service
Voir DĂ©tails

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
Erkunden Sie
Datenraum
Datensatz
Dienstleistung
Siehe Details

Requirements

As this issue regards only the display of the catalog, we can use lorepsum for the titles of the resources and their categories.
We should at least see 1 dataset, 1 service and 1 Data Space to test the labels.

Resources

Mockups

desktop

image.png

Mobile

image

Tablet

image

long titles and description

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Number of participants

Feature: Number of Participants

As a user of the portal,
I want to see the number of participant to OKP4 ecosystem
So that I have information about the dynamism of the community

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the Home Page
Then I should see the Number of participants to OKP4 ecoystem (see mock up)

Scenario: theme switching

Given that I am a user of the web portal,
When I click the theme switcher button,
Then the theme of the entire portal should change to the alternate theme.
And the switcher button should visually reflect the currently selected theme.

Requirements

Until the dedicated service to extract this metric from the blockchain is not ready, the fake data is : 34

Resources

Mockups

Desktop

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Bug: Mobile display - tool bar disappears when scroll

Describe the bug

When I use a mobile phone, and I am on any page of the portal, I scroll down to see the components at the bottom of the page.
These components are not displayed entirely. So I try to scroll down again and then I see the component entirely but the tool bar disappears.

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'app.staging.okp4.network' with a mobile phone
  2. Scroll down to the bottom of the page
  3. See error

Expected behavior

The components at the bottom of the page should appear entirely and the tool bar should not move.

Screenshots

IMG_8438.PNG

IMG_8439.PNG

Smartphone (please complete the following information):

  • Device: iPhone 12
  • OS: iOS 16.2
  • Browser Safari

┆Issue is synchronized with this Wrike task by Unito

# Feat : Resource Detail - Owner metadata

Feat : Resource Detail - Owner metadata

As a user of the portal,
I want to read owner metadata of a shared resource (data or service)
So that I know who shared this resource and its unique identifier

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
Then I should see the key of the owner of the resource, the name of the creator and its unique ID (See mock up)

Scenario: mobile display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
And I use a mobile device
Then I should see the key of the owner of the resource, the name of the creator and its unique ID on its mobile version (See mock up)

Scenario: Internationalization

Given thatI am a user of the web portal (authenticated or unauthenticated),
When the selected language is English
Then texts should be displayed in English language,
Owner
Creator
Unique ID
And metadata of the resources should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Titulaire
Créateur
ID unique
And metadata of the resources should be displayed in French

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
EigentĂŒmer
Ersteller
Eindeutige ID
And metadata of the resources should be displayed in German

Requirements

Mockups

Desktop :
image

Mobile :
image

Environment

Additional informations

None.

[Dataverse] Resource Detail – Metadata profiles

Feat : Resource Detail – Metadata profiles

As a user of the portal,
I want to explore all the available metadata profiles of the resource
So that I can understand better what is the resource and what are its properties.

Acceptance criteria

Scenario: default display (desktop)

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
And I use a desktop device
Then I should see the hierarchical list of metadata profiles (See mock up)
And The first metadata profile should be open
And the metadata of the first profile should be entirely uncollapsed

Scenario: mobile display

Given that I am a user of the web portal (authenticated or unauthenticated),
When I am on the detail page of a resource,
And I use a mobile device
Then I should see the hierarchical list of metadata profiles (See mock up)
And The first metadata profile should be open
And the metadata of the first profile should be entirely uncollapsed

Scenario: Open / Close a profile

Given that I am a user of the web portal (authenticated or unauthenticated),
And I am on the detail page of a resource
And I use any device
When I click on an arrow or a metadata profile title or on the folder logo of a profile
Then The profile opens up / closes down

Scenario: Collapse / Uncollapse metadata

Given that I am a user of the web portal (authenticated or unauthenticated),
And I am on the detail page of a resource
And I use any device
When I click on an arrow or a metadata title
Then The hierarchical level collapse / uncollapse

Scenario: Internationalization

Given thatI am a user of the web portal (authenticated or unauthenticated),
When the selected language is English
Then texts should be displayed in English language,
Metadata
And metadata of the resources should be displayed in English

Given that I am a user of the web portal on the home page,
When the selected language is French
Then texts should be displayed in French language,
Métadonnées
And metadata of the resources should be displayed in French

Given that I am a user of the web portal on the home page,
When the selected language is German
Then texts should be displayed in German language,
Metadaten
And metadata of the resources should be displayed in German

Requirements

Mockups

Desktop :
image

Mobile :
image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat : Tablet display of home page

Feature: Tablet display

As a user of the portal on the portal,
I want to have the portal app adapted to tablets
So that I can have a nice experience using my tablet device

Acceptance criteria

Scenario: Tablet display of the stat cards

Given that I am a user of the OKP4 portal,
And I am using a tablet device,
When I am on the home page
Then the stat cards should appear according to the tablet version (see mock up)

Scenario: Tablet display of the lateral bar

Given that I am a user of the OKP4 portal,
And I am using a tablet device,
When I am on any page of the app
Then lateral bar should appear according to the tablet version (see mock up)

Scenario: Tablet display of the tool bar

Given that I am a user of the OKP4 portal,
And I am using a tablet device,
When I am on any page of the app
Then tool bar should appear according to the tablet version (see mock up)

Requirements

Resources

Mockups

image

image

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

Feat: Data Space governance – Datasets Management Tabs

Feature: Data Space governance – Datasets Management Tabs

As a user of the Data Space,
I want to explore the different Datasets Management tabs
So that I read the terms and conditions of this section

Acceptance criteria

Scenario 1: default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated) on the Data Space governance page,
And I am using a desktop device,
When I am on the Datasets Management section
Then I should see a proper description of the different tabs that appear as presented in the mockup below

Scenario 2: Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated),
And I use a mobile device
When I am on the Datasets Management section
Then I should see a mobile friendly display (See mock up)

Scenario 3: Change tab

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected tab is Reference, Modify, Dereference or Download
Then the adequate selected tab should be displayed (See mock up)

Scenario 4: Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated),
When the selected language is English, French, or German
Then tab title should be displayed in the adequate selected language (See config)

En

Reference
Modify
Dereference
Download

Fr

Référencer
Modifier
Déréférencer
Télécharger

De

Referenzieren
Bearbeiten
Auslisten
Herunterladen

Requirements

  1. Default landing tab is Reference

Resources

Mockups

Desktop

image.png

Mobile

image.png

Environment

Additional informations

None.

create Dataverse card component

Dataverse card component

To do

Create dataverse card component that will be used for the Dataverse catalog page and the Explore block on the homepage

Acceptance criteria

Additional informations

None.

Feat : Data Spage page - number of datasets

Feature: Dataset card - number of datasets & update

As a user on the portal, unauthenticated or not
I want to know the number of datasets, and the last deposit (update) in a particular data space
So that I can know the "size" of the data space in terms of dataset resources, and how often it is updated

Acceptance criteria

Scenario: Default display

Given that I am a user of the portal
And I am using any device,
When I am on data space page
Then I should see the title of the component
And number of datasets, and last deposit should appear as presented in the mockup

Scenario : Internationalization

Given that I am a user of the web portal on a Data Space details page,
When the selected language is English
Then texts should be displayed in English language,
In this Data Space
Datasets
Last update
And the date should be displayed like : Oct 29 2022

Given that I am a user of the web portal on a Data Space details page,
When the selected language is French
Then texts should be displayed in French language,
Dans ce Data Space
Jeux de données
DerniĂšre mise Ă  jour
And the date should be displayed like : 29 Oct 2022

Given that I am a user of the web portal on a Data Space details page,
When the selected language is German
Then texts should be displayed in German language,
In diesem Data Space
DatensÀtze
Letzte Aktualisierung
And the date should be displayed like : 29 Okt 2022

Technical specifications :

Evolution of the component : please note that 2 buttons will be integrated in this card. You can see the mock up on the Figma.

Number of datasets
Number if datasets should be fetched from ontology

Last update
Last Update value (as date) should be fetched from ontology

Config 1 : Number of Services

While ontology is in progress, Datasets number are :

  • Rhizome : 20
  • DS4I : 1

Config 2 : Last update

While ontology is in progress, last update is

  • DS4I : 25/03/2023
  • Rhizome : 28/03/2023

Resources

Mockups

Desktop

image.png

Mobile

image.png

┆Issue is synchronized with this Wrike task by Unito

🚀 Create the next-app

This project will be a next-app, so we need to create the app directly from the official next script by running yarn create next-app --typescript.

This will add the base configuration for the next app, including new v13 features.

Dataverse cards loading

Feature: Dataverse items loading

As a user of the portal,
I want to see some cards skeleton animation
When I arrive on the explore Dataverse page
So that I understand that my action is taken into account and that the content is loading

Acceptance criteria

Scenario 1 : default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a desktop device,
When I am on the explore Dataverse page
Then I should see 9 animated skeleton cards if data are not ready to be displayed

Scenario 2 : Tablet display

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a tablet device,
When I am on the explore Dataverse page
Then I should see 8 animated skeleton cards if data are not ready to be displayed

Scenario 3 : Mobile Display

Given that I am a user of the web portal (unauthenticated or authenticated),
And I am using a mobile device,
When I am on the explore Dataverse page
Then I should see 2 animated skeleton cards if data are not ready to be displayed

Resources

Mockups

Here is an example of inspiration, knowing that we will have to get as close as possible to our current card:

Capture d’écran 2023-03-31 Ă  11.04.45.png

Environment

Additional informations

To implement from scratch, no library should be used.

┆Issue is synchronized with this Wrike task by Unito

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.