[misc][s]: rename Portal.js to PortalJS
This commit is contained in:
@@ -14,7 +14,7 @@ This example creates a portal/showcase for a single dataset. The dataset should
|
||||
## How to use
|
||||
|
||||
```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
|
||||
|
||||
# then run it
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -24,15 +24,15 @@ Built in JavaScript and React on top of the popular [Next.js](https://nextjs.com
|
||||
|
||||
### 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)
|
||||
* [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
|
||||
|
||||
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).
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user