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

[ReadMe][m]: Update portal readme to reflect changes

Browse Source
This commit is contained in:
Rising Odegua
2021-04-19 11:59:28 +01:00
parent 2652f91b70
commit cb98726de1
2 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -42,27 +42,32 @@ Install `yarn`.
Create a demo portal (for a single dataset): Create a demo portal (for a single dataset):
``` ```bash
# note: we have to use `yarn` until #529 is resolved ... npx create next-app -e https://github.com/datopian/portal.js/tree/main/examples/dataset-frictionless
yarn create next-app -e https://github.com/datopian/portal.js/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
cd your-portal cd your-portal
yarn dev yarn #install packages
yarn dev #start app in dev mode
``` ```
You should see the demo portal running. You should see the demo portal running.
<img src="./assets/demo.gif" />
You can try it out with other Frictionless datasets. You can try it out with other Frictionless datasets.
### Check out more of the examples ### Check out more of the examples
Check out more of the examples on how to create a portal for your dataset or datasets in the [`examples` directory](./examples) e.g. The [`examples` directory](./examples) is regularly updated with different portal examples.
* [A portal for a single Frictionless dataset](./examples/dataset-frictionless) * [A portal for a single Frictionless dataset](./examples/dataset-frictionless)
* [A portal with a CKAN backend](./examples/catalog) * [A portal with a CKAN backend](./examples/catalog)
## Deploying portal build to github pages
* [Deploying single frictionless dataset to Github]("./scripts/README.md")
--- ---
# Appendix: What happened to Recline? # Appendix: What happened to Recline?

BIN
assets/demo.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.6 MiB