knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[misc][s]: rename Portal.js to PortalJS

Browse Source
This commit is contained in:
anuveyatsu
2023-04-22 12:11:51 +06:00
parent 7684a89f55
commit cceb1b011e
15 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
site/README.md
View File

@@ -1,4 +1,4 @@
This the Portal.JS website. This the PortalJS website.
It is built on [Next.js](https://nextjs.org/). It is built on [Next.js](https://nextjs.org/).

4
site/components/Community.tsx
View File

@@ -77,7 +77,7 @@ export default function Community() {
<div className="flex flex-wrap justify-center mt-12"> <div className="flex flex-wrap justify-center mt-12">
<IconButton <IconButton
Icon={GitHubIcon} Icon={GitHubIcon}
text="Star Portal.JS on GitHub" text="Star PortalJS on GitHub"
className="sm:mr-4 mb-4 w-full sm:w-auto" className="sm:mr-4 mb-4 w-full sm:w-auto"
href={siteConfig.github} href={siteConfig.github}
/> />
@@ -89,7 +89,7 @@ export default function Community() {
/> />
<IconButton <IconButton
Icon={EmailIcon} Icon={EmailIcon}
text="Subscribe to the Portal.JS newsletter" text="Subscribe to the PortalJS newsletter"
className="w-full sm:w-auto" className="w-full sm:w-auto"
href="#hero" href="#hero"
/> />

4
site/components/Features.tsx
View File

@@ -41,10 +41,10 @@ export default function Features() {
return ( return (
<Container> <Container>
<h2 className="text-3xl font-bold text-primary dark:text-primary-dark"> <h2 className="text-3xl font-bold text-primary dark:text-primary-dark">
How Portal.JS works? How PortalJS works?
</h2> </h2>
<p className="text-lg mt-8"> <p className="text-lg mt-8">
Portal.JS is built in JavaScript and React on top of the popular Next.js PortalJS is built in JavaScript and React on top of the popular Next.js
framework, assuming a "decoupled" approach where the frontend is a framework, assuming a "decoupled" approach where the frontend is a
separate service from the backend and interacts with backend(s) via an 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 API. It can be used with any backend and has out of the box support for

2
site/components/Gallery.tsx
View File

@@ -55,7 +55,7 @@ export default function Gallery() {
> >
Gallery Gallery
</h2> </h2>
<p className="text-lg mt-8">Discover what's being powered by Portal.JS</p> <p className="text-lg mt-8">Discover what's being powered by PortalJS</p>
<div className="not-prose my-12 grid grid-cols-1 gap-6 md:grid-cols-2 lg:grid-cols-3"> <div className="not-prose my-12 grid grid-cols-1 gap-6 md:grid-cols-2 lg:grid-cols-3">
{items.map((item) => { {items.map((item) => {
return <GalleryItem item={item} />; return <GalleryItem item={item} />;

4
site/content/blog/example-ckan-2021.md
View File

@@ -14,7 +14,7 @@ We have created a full data portal demo using PortalJS all backed by a CKAN inst
To create a Portal app, run the following command in your terminal: To create a Portal app, run the following command in your terminal:
```console ```console
npx create-next-app -e https://github.com/datopian/portal.js/tree/main/examples/ckan npx create-next-app -e https://github.com/datopian/portaljs/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. > NB: Under the hood, this uses the tool called create-next-app, which bootstraps an app for you based on our CKAN example.
@@ -75,7 +75,7 @@ For development/debugging purposes, we suggest installing the Chrome extension -
### I18n configuration ### 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; PortalJS 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 1. Update `next.config.js`, to add more languages to the i18n locales

4
site/content/blog/example-ckan.md
View File

@@ -4,9 +4,9 @@ authors: ['Luccas Mateus']
date: 2023-04-20 date: 2023-04-20
--- ---
Portal.js is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications. PortalJS is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications.
The ckan-example added to Portal.js is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores behind a CKAN Backend. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done just by adding a simple env variable pointing to a CKAN Deployment. The ckan-example added to PortalJS is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores behind a CKAN Backend. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done just by adding a simple env variable pointing to a CKAN Deployment.
To get a feel of the project, users can check the [live deployment](https://ckan-example.portaljs.org). To get a feel of the project, users can check the [live deployment](https://ckan-example.portaljs.org).

4
site/content/blog/example-data-catalog.md
View File

@@ -4,9 +4,9 @@ authors: ['Luccas Mateus']
date: 2023-04-20 date: 2023-04-20
--- ---
Portal.js is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications. PortalJS is an open source project that aims to simplify the creation of web-based data portals, making it easy for users to create and share data-driven applications.
The simple-example added to Portal.js is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores stored in GitHub repositories. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done thru the configuration of a simple `datasets.json` file. The simple-example added to PortalJS is intended to provide users with an easy way to set up a data catalog that can be used to display and share data stores stored in GitHub repositories. With this example, users can quickly set up a web-based portal that allows them to showcase their data and make it accessible to others, all this being done thru the configuration of a simple `datasets.json` file.
To get a feel of the project, users can check the [live deployment](https://example.portaljs.org). To get a feel of the project, users can check the [live deployment](https://example.portaljs.org).

12
site/content/config.js
View File

@@ -1,8 +1,8 @@
const config = { const config = {
title: title:
"Portal.JS", "PortalJS",
description: description:
"Portal.JS is a framework for rapidly building rich data portal frontends using a modern frontend approach. portal.js can be used to present a single dataset or build a full-scale data catalog/portal.", "PortalJS is a framework for rapidly building rich data portal frontends using a modern frontend approach. PortalJS can be used to present a single dataset or build a full-scale data catalog/portal.",
theme: { theme: {
default: "dark", default: "dark",
toggleIcon: "/images/theme-button.svg", toggleIcon: "/images/theme-button.svg",
@@ -12,7 +12,7 @@ const config = {
authorUrl: "https://datopian.com/", authorUrl: "https://datopian.com/",
navbarTitle: { navbarTitle: {
// logo: "/images/logo.svg", // logo: "/images/logo.svg",
text: "🌀 Portal.JS", text: "🌀 PortalJS",
// version: "Alpha", // version: "Alpha",
}, },
navLinks: [ navLinks: [
@@ -29,14 +29,14 @@ const config = {
openGraph: { openGraph: {
type: "website", type: "website",
title: title:
"Portal.JS - Rapidly build rich data portals using a modern frontend framework", "PortalJS - rapidly build rich data portals using a modern frontend framework.",
description: description:
"Portal.JS is a framework for rapidly building rich data portal frontends using a modern frontend approach. portal.js can be used to present a single dataset or build a full-scale data catalog/portal.", "PortalJS is a framework for rapidly building rich data portal frontends using a modern frontend approach. PortalJS can be used to present a single dataset or build a full-scale data catalog and portal.",
locale: "en_US", locale: "en_US",
images: [ images: [
{ {
url: "/homepage-screenshot.png", // TODO url: "/homepage-screenshot.png", // TODO
alt: "Portal.JS - Rapidly build rich data portals using a modern frontend framework", alt: "PortalJS - rapidly build rich data portals using a modern frontend framework.",
width: 1280, width: 1280,
height: 720, height: 720,
type: "image/jpg", type: "image/jpg",

4
site/content/data-literate/demo.mdx
View File

@@ -13,7 +13,7 @@ You can see the raw source of this page here: https://raw.githubusercontent.com/
We can have github-flavored markdown including markdown tables, auto-linked links and checklists: We can have github-flavored markdown including markdown tables, auto-linked links and checklists:
``` ```
https://github.com/datopian/portal.js https://github.com/datopian/portaljs
| a | b | | a | b |
|---|---| |---|---|
@@ -23,7 +23,7 @@ https://github.com/datopian/portal.js
* [ ] a second thing to do * [ ] a second thing to do
``` ```
https://github.com/datopian/portal.js https://github.com/datopian/portaljs
| a | b | | a | b |
|---|---| |---|---|

2
site/content/docs/example-frictionless-dataset.md.bkp
View File

@@ -14,7 +14,7 @@ This example creates a portal/showcase for a single dataset. The dataset should
## How to use ## How to use
```bash ```bash
npx create-next-app -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless npx create-next-app -e https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless
# choose a name for your portal when prompted e.g. your-portal or go with default my-app # choose a name for your portal when prompted e.g. your-portal or go with default my-app
# then run it # then run it

12
site/content/docs/index.md
View File

@@ -1,8 +1,8 @@
# 🌀 Portal.JS: The JavaScript framework for data portals # 🌀 PortalJS: The JavaScript framework for data portals
🌀 Portal.JS is a framework for rapidly building rich data portal frontends using a modern frontend approach. Portal.JS can be used to present a single dataset or build a full-scale data catalog/portal. 🌀 PortalJS is a framework for rapidly building rich data portal frontends using a modern frontend approach. PortalJS can be used to present a single dataset or build a full-scale data catalog/portal.
Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com/) framework. Portal.JS 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](https://ckan.org/). Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com/) framework. PortalJS 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](https://ckan.org/).
## Features ## Features
@@ -24,15 +24,15 @@ Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com
### Examples ### Examples
You can check out the following examples built with Portal.js. You can check out the following examples built with PortalJS.
* [Data catalog with data coming from CKAN](/docs/example-ckan) * [Data catalog with data coming from CKAN](/docs/example-ckan)
* [Simple data catalog](/docs/example-data-catalog) * [Simple data catalog](/docs/example-data-catalog)
> The [`examples` directory](https://github.com/datopian/portal.js/tree/main/examples) is regularly updated with different portal examples. > The [`examples` directory](https://github.com/datopian/portaljs/tree/main/examples) is regularly updated with different portal examples.
## Getting Help ## Getting Help
If you have questions about anything related to Portal.js, you're always welcome to ask our community on [GitHub Discussions](https://github.com/datopian/portal.js/discussions) or on our [Discord server](https://discord.gg/An7Bu5x8). If you have questions about anything related to PortalJS, you're always welcome to ask our community on [GitHub Discussions](https://github.com/datopian/portaljs/discussions) or on our [Discord server](https://discord.gg/An7Bu5x8).

2
site/content/docs/references.md
View File

@@ -1,6 +1,6 @@
# Concepts and Terms # Concepts and Terms
In this section, we explain some of the terms and concepts used throughtout the portal.js documentation. In this section, we explain some of the terms and concepts used throughtout the PortalJS documentation.
> Some of these concepts are part of official specs, and when appropriate, we'll link to the sources where you can get more details. > Some of these concepts are part of official specs, and when appropriate, we'll link to the sources where you can get more details.

2
site/public/scripts/actions/single-dataset-ssg.yml
View File

@@ -20,7 +20,7 @@ jobs:
env: env:
PORTAL_REPO_NAME: ${{ secrets.PORTAL_REPO_NAME }} PORTAL_REPO_NAME: ${{ secrets.PORTAL_REPO_NAME }}
run: | run: |
curl https://raw.githubusercontent.com/datopian/portal.js/main/site/public/scripts/single-dataset-no-commit.sh > portal.sh curl https://raw.githubusercontent.com/datopian/portaljs/main/site/public/scripts/single-dataset-no-commit.sh > portal.sh
git config --local user.email "$(git log --format='%ae' HEAD^!)" git config --local user.email "$(git log --format='%ae' HEAD^!)"
git config --local user.name "$(git log --format='%an' HEAD^!)" git config --local user.name "$(git log --format='%an' HEAD^!)"
source ./portal.sh source ./portal.sh

4
site/public/scripts/single-dataset-commit.sh
View File

@@ -1,7 +1,7 @@
#!/bin/bash #!/bin/bash
rm -rf portal rm -rf portal
mkdir -p portal mkdir -p portal
npx create-next-app portal -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless npx create-next-app portal -e https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless
mkdir portal/public/dataset mkdir portal/public/dataset
cp -a ./data portal/public/dataset cp -a ./data portal/public/dataset
@@ -12,7 +12,7 @@ PORTAL_DATASET_PATH=$PWD"/portal/public/dataset"
export PORTAL_DATASET_PATH export PORTAL_DATASET_PATH
mkdir -p .github && mkdir -p .github/workflows && touch .github/workflows/main.yml mkdir -p .github && mkdir -p .github/workflows && touch .github/workflows/main.yml
curl https://raw.githubusercontent.com/datopian/portal.js/main/site/public/scripts/gh-page-builder-action.yml > .github/workflows/main.yml curl https://raw.githubusercontent.com/datopian/portaljs/main/site/public/scripts/gh-page-builder-action.yml > .github/workflows/main.yml
cd portal cd portal
assetPrefix='"/'$PORTAL_REPO_NAME'/"' assetPrefix='"/'$PORTAL_REPO_NAME'/"'

2
site/public/scripts/single-dataset-no-commit.sh
View File

@@ -3,7 +3,7 @@ git checkout -b gh-pages
git rm -r --cached . git rm -r --cached .
rm -rf portal rm -rf portal
mkdir -p portal mkdir -p portal
npx create-next-app portal -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless npx create-next-app portal -e https://github.com/datopian/portaljs/tree/main/examples/dataset-frictionless
mkdir portal/public/dataset mkdir portal/public/dataset
cp -a ./data portal/public/dataset cp -a ./data portal/public/dataset