diff --git a/site/content/learn.md b/site/content/learn.md index 8a8a1c49..e927299d 100644 --- a/site/content/learn.md +++ b/site/content/learn.md @@ -65,3 +65,7 @@ npm run dev This starts your Portal.js app’s "development server" (more on this later) on port 3000. Let’s check to see if it’s working. Open http://localhost:3000 from your browser. + +## Next steps + +* Learn how to use Portal.js as a frontend for CKAN - [learn/ckan](/learn/ckan). \ No newline at end of file diff --git a/site/content/learn/ckan.md b/site/content/learn/ckan.md new file mode 100644 index 00000000..828fbb12 --- /dev/null +++ b/site/content/learn/ckan.md @@ -0,0 +1,220 @@ +Live DEMOs: + +- https://catalog-portal-js.vercel.app +- https://ckan-enterprise-frontend.vercel.app/ + +## Create a Portal app for CKAN + +To create a Portal app, run the following command in your terminal: + +```console +npx create-next-app -e https://github.com/datopian/portal.js/tree/main/examples/ckan +``` + +> NB: Under the hood, this uses the tool called create-next-app, which bootstraps an app for you based on our CKAN example. + +## Guide + +### Styling 🎨 + +We use Tailwind as a CSS framework. Take a look at `/styles/globals.css` to see what we're importing from Tailwind bundle. You can also configure Tailwind using `tailwind.config.js` file. + +Have a look at Next.js support of CSS and ways of writing CSS: + +https://nextjs.org/docs/basic-features/built-in-css-support + +### Backend + +So far the app is running with mocked data behind. You can connect CMS and DMS backends easily via environment variables: + +```console +$ export DMS=http://ckan:5000 +$ export CMS=http://myblog.wordpress.com +``` + +> Note that we don't yet have implementations for the following CKAN features: +> +> - Activities +> - Auth +> - Groups +> - Facets + +### Routes + +These are the default routes set up in the "starter" app. + +- Home `/` +- Search `/search` +- Dataset `/@org/dataset` +- Resource `/@org/dataset/r/resource` +- Organization `/@org` +- Collection (aka group in CKAN) (?) - suggest to merge into org +- Static pages, eg, `/about` etc. from CMS or can do it without external CMS, e.g., in Next.js. + +### New Routes + +You can create new routes in `/pages` directory where each file is associated with a route based on its name. We suggest using [Next.JS docs][] for more detailed information. + +[Next.JS docs]: https://nextjs.org/docs/basic-features/pages + +### Data fetching + +We use Apollo client which allows us to query data with GraphQL. We have setup CKAN API for the demo (it uses demo.ckan.org as DMS): + +http://portal.datopian1.now.sh/ + +Note that we don't have Apollo Server but we connect CKAN API using [`apollo-link-rest`](https://www.apollographql.com/docs/link/links/rest/) module. You can see how it works in [lib/apolloClient.ts](https://github.com/datopian/portal/blob/master/lib/apolloClient.ts) and then have a look at [pages/\_app.tsx](https://github.com/datopian/portal/blob/master/pages/_app.tsx). + +For development/debugging purposes, we suggest installing the Chrome extension - https://chrome.google.com/webstore/detail/apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm. + +### I18n configuration + +Portal.js is configured by default to support both `English` and `French` subpath for language translation. But for subsequent users, this following steps can be used to configure i18n for other languages; + +1. Update `next.config.js`, to add more languages to the i18n locales + +```js +i18n: { + locales: ['en', 'fr', 'nl-NL'], // add more language to the list + defaultLocale: 'en', // set the default language to use +}, +``` + +2. Create a folder for the language in `locales` --> `locales/en-Us` + +3. In the language folder, different namespace files (json) can be created for each translation. For the `index.js` use-case, I named it `common.json` + +```json +// locales/en/common.json +{ + "title" : "Portal js in English", +} + +// locales/fr/common.json +{ + "title" : "Portal js in French", +} +``` + +4. To use on pages using Server-side Props. + +```js +import { loadNamespaces } from './_app'; +import useTranslation from 'next-translate/useTranslation'; + +const Home: React.FC = ()=> { + const { t } = useTranslation(); + return ( +