knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
datahub/DESIGN.md
Rufus Pollock 2562781e3e [refactor,#527][m]: move the nextjs app at root of repo to examples/dataset-frictionless. 
The current app at root of repo is for single frictionless dataset. Should be in its own example so we have space going forward for multiple example and for root to have core portal.js code.

* Also refactor its README (moved from root) to reflect it is just an example
* Move design content from the root README.md into DESIGN.md
* Stub a new root README.md based largely on examples/catalog/README.md
2021-04-12 16:15:20 +02:00

618 B
Raw Blame History

Design Notes

Portal.js is a React and NextJS based framework for building dataset/resources pages and catalogs. It consists of:

  • React components for data portal functionality e.g. data tables, graphs, dataset pages etc
  • Tooling to load data (based on Frictionless)
  • Template sites you can reuse using create-next-app
    • Single dataset micro-site
    • Github backed catalog
    • CKAN backed catalog
    • ...
  • Local development environment
  • Deployment integration with DataHub.io

In summary, technically PortalJS is: NextJS + data specific react components + data loading glue (mostly using frictionless-js).