From 17e7434c97d800ff8a8786e41b6e00889efe9bfc Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 21 Apr 2023 13:24:25 +0200 Subject: [PATCH] [ex/ckan-2021,#757][s]: update README to indicate deprecation and remove repetition from main README. --- examples/ckan-2021/README.md | 52 ++---------------------------------- 1 file changed, 2 insertions(+), 50 deletions(-) diff --git a/examples/ckan-2021/README.md b/examples/ckan-2021/README.md index 74592e54..5caa503f 100644 --- a/examples/ckan-2021/README.md +++ b/examples/ckan-2021/README.md @@ -1,54 +1,6 @@ -

+# πŸŒ€ PortalJS example with CKAN and Apollo -πŸŒ€ Portal.JS
-The javascript framework for
-data portals - -

- -πŸŒ€ `Portal` is a framework for rapidly building rich data portal frontends using a modern frontend approach (javascript, React, SSR). - -`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][]. `portal` is built in Javascript and React on top of the popular [Next.js][] framework. - -[ckan]: https://ckan.org/ -[next.js]: https://nextjs.com/ - -Live DEMO: https://catalog-portal-js.vercel.app - -## 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 - -## Getting Started - -### Setup - -Install a recent version of Node. You'll need Node 10.13 or later. - -### Create a Portal app - -To create a Portal app, open your terminal, cd into the directory you'd like to create the app in, and run the following command: - -```console -npm init portal-app my-data-portal -``` - -> NB: Under the hood, this uses the tool called create-next-app, which bootstraps a Next.js app for you. It uses this template through the --example flag. -> -> If it doesn’t work, please open an issue. +**🚩 UPDATE April 2023: This example is now deprecated - though still works!. Please use the [new CKAN examples](https://github.com/datopian/portaljs/tree/main/examples)** ## Guide