IATI.cloud.frontend
The front-end to the iati.cloud backend (aka IATI Datastore). If you like to build queries using a web interfaces with IATI Data, make sure to install this.
Install / Use
/learn @zimmerman-team/IATI.cloud.frontendREADME
What is the IATI Query Builder?
The IATI Query Builder runs on top the the iati.cloud API application. It will allow users to interact with all the IATI data that is available in the IATI Registry using a form based interface which enables a user to select what IATI fields to extract, select dates and output formats.
IATI is a global aid transparency standard and it makes information about aid spending easier to access, re-use and understand the underlying data using a unified open standard. You can find more about the IATI XML standard at: <a href="http://www.iatistandard.org" target="_blank">www.iatistandard.org</a>
About the project
- Website: <a href="https://www.iati.cloud" target="_blank">www.iati.cloud</a>
- Authors: <a href="https://www.zimmerman.team/" target="_blank">Zimmerman</a>
- License: AGPLv3 (see included <a href="https://github.com/zimmerman-team/iati.cloud.frontend/blob/develop/LICENSE.MD" target="_blank">LICENSE</a> file for full license)
- Github Repo: <a href="https://github.com/zimmerman-team/iati.cloud.frontend/" target="_blank">github.com/zimmerman-zimmerman/iati.cloud.frontend</a>
- Bug Tracker: <a href="https://github.com/zimmerman-team/iati.cloud.frontend/issues" target="_blank">github.com/zimmerman-zimmerman/iati.cloud.frontend/issues</a>
Installing
<b>1.</b> Set up the <a href="https://github.com/zimmerman-team/iati.cloud" target="_blank">iati.cloud backend</a> first<br/>
<b>2.</b> Checkout this repository to a local folder<br/>
<b>3.</b> Make sure you've installed node.js 10.16.3 or higher<br/>
<b>4.</b> Run yarn install <br/>
<b>5.</b> Create an .env file and specify the following variables:
- NODE_PATH=src/
- REACT_APP_CLIENT_NAME=IATI.cloud
<b>6.</b> Run yarn start
Documentation
For a birds eye view on the different facets of the query builder please take the following steps:
<b>1.</b> Install <a href="https://github.com/Bogdan-Lyashenko/codecrumbs">codecrumbs</a> by running: yarn global add codecrumbs<br/>
<b>2.</b> Start by running: codecrumbs<br/>
<b>3.</b> Open a browser window or a new tab and navigate to: http://localhost:1234<br/>
Can I contribute?
Yes! We are mainly looking for coders to help on the project. If you are a coder feel free to Fork the repository and send us Pull requests!
