diff --git a/examples/ckan-example/README.md b/examples/ckan-example/README.md new file mode 100644 index 00000000..f329bd6f --- /dev/null +++ b/examples/ckan-example/README.md @@ -0,0 +1,17 @@ +This is a repo intended to serve as an example of a data catalog that get its data from a CKAN Instance. + +- Creating a new file inside o `examples` with `create-next-app` like so: +``` +npx create-next-app --example https://github.com/datopian/portaljs/tree/main/ --example-path examples/ckan-example +``` +- Inside `` go to the `project.json` file and replace all instances of `ckan-example` with `` +- Set the `DMS` env variable to the Url of the CKAN Instance Ex: `export DMS=https://demo.dev.datopian.com` +- Run the app using: +``` +nx serve +``` +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) +If yo go to any one of those pages by clicking on `More info` you will see something similar to this +![](https://media.discordapp.net/attachments/1069718983604977754/1098252298074988595/image.png?width=853&height=461) + diff --git a/examples/simple-example/README.md b/examples/simple-example/README.md index fb98d0fb..733b798b 100644 --- a/examples/simple-example/README.md +++ b/examples/simple-example/README.md @@ -1,4 +1,4 @@ -This is a repo intended to serve as an 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. +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. - Creating a new file inside o `examples` with `create-next-app` like so: ```