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

[#796,site][m]: update /docs with more info, make examples doc and blog a single page

Browse Source
This commit is contained in:
deme 2023-04-24 16:48:49 -03:00
parent 7002b5669c
commit 1770deb960
4 changed files with 48 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,27 +0,0 @@
---
title: "Example: data catalog with data coming from CKAN"
authors: ['Luccas Mateus']
date: 2023-04-20
---
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 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).
Below are some screenshots:
### Front page
![](https://i.imgur.com/NlTAIAg.png)
### Individual dataset page
![](https://i.imgur.com/RRoIlGf.png)
## Links
- [Documentation](/docs/example-ckan)
- [Repo](https://github.com/datopian/portaljs/tree/main/examples/ckan-example)
- [Live Demo](https://ckan-example.portaljs.org)

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

@ -1,28 +0,0 @@
---
title: "Example: simple data catalog"
authors: ['Luccas Mateus']
date: 2023-04-20
---
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 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).
Below are some screenshots:
### Front page
![](https://i.imgur.com/jAljJ9C.png)
### Individual dataset page
![](https://i.imgur.com/AoJd4O0.png)
## Links
- [Documentation](/docs/example-data-catalog)
- [Repo](https://github.com/datopian/portaljs/tree/main/examples/simple-example)
- [Live Demo](https://example.portaljs.org)

30
site/content/docs/example-ckan.md
View File

@ -1,23 +1,39 @@
---
title: "Example: data catalog with data coming from CKAN"
title: "Example: Data catalog with data coming from CKAN"
authors: ['Luccas Mateus']
date: 2023-04-20
filetype: blog
---
**See the repo:** https://github.com/datopian/portaljs/tree/main/examples/ckan-example
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.
This is a repo intended to serve as an example of a data catalog that get its data from a CKAN Instance.
## Demo
- Creating a new file inside o `examples` with `create-next-app` like so:
To get a feel of the project, users can check the [live deployment](https://ckan-example.portaljs.org).
Below are some screenshots:
#### Front page
![](https://i.imgur.com/NlTAIAg.png)
#### Individual dataset page
![](https://i.imgur.com/RRoIlGf.png)
## How to use this example as a template
- Create a new file inside of `examples` with `create-next-app`:
```
npx create-next-app <app-name> --example https://github.com/datopian/portaljs/tree/main/ --example-path examples/ckan-example
```
- Inside `<app-name>` go to the `project.json` file and replace all instances of `ckan-example` with `<app-name>`
- Set the `DMS` env variable to the Url of the CKAN Instance Ex: `export DMS=https://demo.dev.datopian.com`
- Run the app using:
- Inside `<app-name>`, go to the `project.json` file and replace all instances of `ckan-example` with `<app-name>`
- Set the `DMS` env variable to the Url of the CKAN Instance, eg.: `export DMS=https://demo.dev.datopian.com`
- Run the app:
```
nx serve <app-name>
```
Congratulations, you now have something similar to this running on `http://localhost:4200`
![](https://media.discordapp.net/attachments/1069718983604977754/1098252297726865408/image.png?width=853&height=461)

30
site/content/docs/example-data-catalog.md
View File

@ -1,14 +1,29 @@
---
title: "Example: simple data catalog"
title: "Example: Simple data catalog"
authors: ['Luccas Mateus']
date: 2023-04-20
filetype: blog
---
**See the repo:** https://github.com/datopian/portaljs/tree/main/examples/simple-example
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.
This is a repo intended to serve as a simple example of a data catalog that get its data from a series of github repos, you can init an example just like this one by.
## Demo
- Creating a new file inside of `examples` with `create-next-app` like so:
To get a feel of the project, users can check the [live deployment](https://example.portaljs.org).
Below are some screenshots:
#### Front page
![](https://i.imgur.com/jAljJ9C.png)
#### Individual dataset page
![](https://i.imgur.com/AoJd4O0.png)
## How to use this example as a template
- Create a new file inside of `examples` with `create-next-app`:
```
npx create-next-app <app-name> --example https://github.com/datopian/portaljs/tree/main/ --example-path examples/simple-example
```
@ -22,6 +37,11 @@ nx serve <app-name>
Congratulations, you now have something similar to this running on `http://localhost:4200`
![](https://i.imgur.com/JrDLycF.png)
If yo go to any one of those pages by clicking on `More info` you will see something similar to this
If you go to any one of those pages by clicking on `More info` you will see something similar to this
![](https://i.imgur.com/cpKMS80.png)
## Links
- [Repo](https://github.com/datopian/portaljs/tree/main/examples/simple-example)
- [Live Demo](https://example.portaljs.org)