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

[#810, github-backed example][xl]: improve looks, improve README, rename from simple-example to github-backed (#864)

Browse Source
This commit is contained in:
João Demenech
2023-05-09 19:19:36 -03:00
committed by GitHub
parent 714faf9986
commit 3f350f8fcd
24 changed files with 258 additions and 518 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
site/content/docs/examples/example-ckan.md
View File

@@ -1,5 +1,5 @@
---
title: "Example: Data catalog with data coming from CKAN"
title: "Example: Data catalog with data on CKAN"
authors: ['Luccas Mateus']
date: 2023-04-20
filetype: blog

10
site/content/docs/examples/example-data-catalog.md → site/content/docs/examples/github-backed-catalog.md
View File

@@ -1,11 +1,11 @@
---
title: "Example: Simple data catalog"
title: "Example: Data catalog with data on GitHub"
authors: ['Luccas Mateus']
date: 2023-04-20
filetype: blog
---
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.
The github-backed 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 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.
## Demo
@@ -25,7 +25,7 @@ Below are some screenshots:
- Create a new app with `create-next-app`:
```
npx create-next-app <app-name> --example https://github.com/datopian/portaljs/tree/main/examples/simple-example
npx create-next-app <app-name> --example https://github.com/datopian/portaljs/tree/main/examples/github-backed-catalog
cd <app-name>
```
@@ -46,7 +46,7 @@ Congratulations, you now have something similar to this running on `http://local
## Deployment
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fportaljs%2Ftree%2Fmain%2Fexamples%2Fsimple-example)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdatopian%2Fportaljs%2Ftree%2Fmain%2Fexamples%2Fgithub-backed-catalog)
By clicking on this button, you will be redirected to a page which will allow you to clone the content into your own github/gitlab/bitbucket account and automatically deploy everything.
@@ -94,5 +94,5 @@ npm run start
## Links
- [Repo](https://github.com/datopian/portaljs/tree/main/examples/simple-example)
- [Repo](https://github.com/datopian/portaljs/tree/main/examples/github-backed-catalog)
- [Live Demo](https://example.portaljs.org)