To sample the application:
-
Run an instance of vanilla ckan on port 5000. (You can use a source install or the OKF docker-ckan)
-
Once CKAN is running on port 5000 run:
yarn && yarn start
You should see:=
To output as a single file (best for compatibility with fanstatic and CKAN) run:
yarn build:bundle
This will create a loadable script at /dist/build/static/js/bundle.min.js
To use the standard react-scripts/create-react-app build script run:
yarn build
This will create a manifest and a multi-file build as per normal for create-react-app
For an example of how to embed the app see pubic/index.html
Add a div element as follows... note that data-config values can be changed as per (config)[#config]
<div id="dep-of-ed-admin-ui" data-config='{"apiUrl": "http://localhost:5000/api/3/acti on/", "debug": true, "collectionId": "ppp", "isMaster": true}'></div>
This should work :)
isMaster: bool - whether or not this is a master collection apiUrl: url - fully qualified URL pointing to ckan API -- include trailing slash addDocsUrl: url - base path to admin form to add resources to summary dataset; note the colleciton id will be appended to this debug: bool - Enable debug mode
- Instantiate (as above)[#Embedding the app] without passing
collectionId
- Make sure to include
isMaster
value to instantiate the master collections form
For development you can use cosmos
Cosmos fixtures are located in the __fixtures__
directory
To preview component with cosmos:
yarn && yarn cosmos
This project was bootstrapped with Create React App.
yarn test
TODO - better test coverage :)
Many fields are stored in CKAN's "Extras".
This requires the App's API layer (src/Api.js
) to map form fields to the extras fields format.
**If you add another Extras field you need to add it to the EXTRAS
array at the top of Api.js`
- Internal routing
- Multiple collections/groups
- Other CKAN administrative tasks
- A more complete es6 CKAN API interface
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject
, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject
at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject
will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject
. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify