Code Monkey home page Code Monkey logo

aleph-ui's People

Contributors

benoccrp avatar felixebert avatar pudo avatar sungraze avatar wpf500 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

reuf

aleph-ui's Issues

Display entities and documents details

  • Document metadata
  • Make a big deal of the source info (i.e. collection)
  • At some point, there will be various document types: pdf, tabular, plain text, html, folder.
  • For documents, show records highlights

Login/logout workflow

Users should be able to log in and out of Aleph using the user interface. Logout and OAuth sign-in is invoked by redirecting the browser to specific endpoints. Session state is available as an API call.

  • For username and password authentication, a form must be submitted.

cf.

Home page

  • Big search bar
  • Menu with login/logout...
  • Possibly: list sources in some way?

Framework choices

Aleph is going through a redesign process. As part of the effort, we will be updating the UI of the product.

Currently, Aleph is using the Angular 1.x framework for the UI. Due to maintenance issues, we decided to move away from Angular and we are considering a modern alternative to it. The decision should be based on the following aspects:

  • community support and the maturity of the project
  • the maturity of the tools for testing, deployments and QA
  • learning curve

Related to the framework choices, we are exploring any UI components framework/toolset/addons that can play well with it and potentially reduce the boilerplate to speed the delivery times.


Currently, I'd propose:

  • React
  • Redux
  • Bootstrap 3 or 4

I've had a very quick look at MobX, which seems pretty magical but fundamentally does the same thing as Redux. I don't have strong feelings either way, other than all other things being equal, I'd much prefer adopting a widely used and maintained JavaScript library than one that is not, i.e. does MobX mean that components made by us can only be used in a MobX-based app and that those re-usable components out in the React ecosystem that assume Redux will be inaccessible to us?

Tabular view of data in collections

[ moved from alephdata/aleph#214 ]

Make it easy to browse through details of objects in collections.

Idea: user can pick which fields about an entity or a document are useful, then the UI presents the whole collection in a table, spreadsheet style, with the fields as columns.

(Probably limit the number of columns at some point for usability).

Various UI grievances to be fixed

ported from alephdata/aleph#142

  • Replace "Possible duplicates" section in entity view with something "less confusing" (user quote).
  • Make it easier to find your personal collections from current investigations.
  • Inside collections, rework the whole user experience (needs a UX person)
  • Separate entity links into different categories and show these as separate pagers on entity profiles ("subsidiaries", "shareholders", "family", "directors").
  • Allow users to delete documents via the UI (API endpoint exists).

Handling nested documents

Several types of documents are stored as nested structures, including emails, folders, zip files or excel files. These need to be browsable both in the search result view and in the context of a collection. We need a nice, Dropbox-inspired ui for this.

Make a document search results listing

A simple react route that allows the user to input a search query, submit it and have a list of documents shown to them in response. Each document should be listed using it's title, source collection and other metadata such as update date and language. Within each document hit, a set of preview snippets for individual pages are to be shown.

  • Use the /api/2/search API endpoint. It accepts q= as a primary search query, and limit/offset for pagination.

  • Input form with search button (should also just search on form submit)

  • Pagination for result pages (or infinte scrolling)

  • Facet by schema and show them as tabs on top of the result list

  • Source selector? Maybe as an overlay or drop-down.

  • Clicking on a result should bring up a sidebar with document metadata or entity data, i.e. render #6 into a smaller form.

The current implementation of this (which also supports facets, sorting and alerts) is here:

https://data.occrp.org/documents?q=demo

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.