2021-05-05 15:51:34 +01:00
2021-05-05 08:21:15 +02:00
2021-05-03 09:30:15 +01:00
2021-04-12 19:04:59 +02:00
2021-03-08 12:33:32 +01:00

🌀 Portal.JS
The javascript framework for
data portals

🌀 portal is a framework for rapidly building rich data portal frontends using a modern frontend approach. portal can be used to present a single dataset or build a full-scale data catalog/portal.

portal is built in Javascript and React on top of the popular Next.js framework. portal assumes a "decoupled" approach where the frontend is a separate service from the backend and interacts with backend(s) via an API. It can be used with any backend and has out of the box support for CKAN.

Features

  • 🗺️ Unified sites: present data and content in one seamless site, pulling datasets from a DMS (e.g. CKAN) and content from a CMS (e.g. wordpress) with a common internal API.
  • 👩‍💻 Developer friendly: built with familiar frontend tech Javascript, React etc
  • 🔋 Batteries included: Full set of portal components out of the box e.g. catalog search, dataset showcase, blog etc.
  • 🎨 Easy to theme and customize: installable themes, use standard CSS and React+CSS tooling. Add new routes quickly.
  • 🧱 Extensible: quickly extend and develop/import your own React components
  • 📝 Well documented: full set of documentation plus the documentation of NextJS and Apollo.

For developers

  • 🏗 Build with modern, familiar frontend tech such as Javascript and React.
  • 🚀 NextJS framework: so everything in NextJS for free React, SSR, static site generation, huge number of examples and integrations etc.
    • SSR => unlimited number of pages, SEO etc whilst still using React.
    • Static Site Generation (SSG) (good for small sites) => ultra-simple deployment, great performance and lighthouse scores etc
  • 📋 Typescript support

Check out more of the examples

The examples directory is regularly updated with different portal examples.

Deploying portal build to github pages


Appendix: What happened to Recline?

Portal.JS used to be Recline(JS). If you are looking for the old Recline codebase it still exists: see the recline branch. If you want context for the rename see this issue.

Description
🌀 Rapidly build feature-rich data portals using a modern frontend framework. CKAN compatible.
Readme 104 MiB
Languages
TypeScript 69%
JavaScript 20.1%
CSS 10.6%
Shell 0.3%