Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional API endpoint for last business-type updates in the TruBudget system #1965

Open
jzakotnik opened this issue Sep 6, 2024 · 5 comments
Labels
api Indicates api related issue or feature feature Indicates a new feature implementation good first issue Good for newcomers

Comments

@jzakotnik
Copy link
Contributor

To better understand, how often data in a TruBudget system is updated, it would be nice to have an API endpoint, that returns the last e.g. 10 updated timestamps, when something was changed in the system. Potentially also if it was project, subproject or workflow item.

For permission reasons, there doesn't need to be more detailed data.

With the API endpoint, one could integrate this in the dashboard for trubudget operations.

@jzakotnik jzakotnik added good first issue Good for newcomers feature Indicates a new feature implementation api Indicates api related issue or feature labels Sep 6, 2024
@jzakotnik jzakotnik changed the title Additional API endpoint Additional API endpoint for last business-type updates in the TruBudget system Sep 6, 2024
@amha-mersha
Copy link

Hello there, I would like to take this and work on it.

@jzakotnik
Copy link
Contributor Author

@amha-mersha Thank you very much for the contribution. Do you need any help describing what is useful and how to implement it?

@amha-mersha
Copy link

Yes, that would be great if it's not a burden. If you would show me the file/folder I'll be working on some description resources about the project

@jzakotnik
Copy link
Contributor Author

@amha-mersha I believe I would follow this approach:

  • Install docker
  • Start TruBudget from a container, using
cp scripts/operation/.env.example scripts/operation/.env
bash scripts/operation/start-trubudget.sh --slim
  • Once started, the API documentation is available under http://localhost:3000/api/documentation/static/index.html. So you should see the swagger documentation. Does this work?
  • Have a look at api/src/system/getVersion.ts, this is a good example which corresponds to http://localhost:3000/api/documentation/static/index.html#/system/get_api_version. Here you see the object multichainClient, which is the entry point to retrieve respective information from the multichain-blockchain. Does this work?

Let's have a quick break here and check if this works for you, then we can further deep dive into the code.

@MartinJurcoGlina
Copy link
Collaborator

@amha-mersha @jzakotnik for development purposes I would refer to these guides that further specify prerequisities, installation etc..
https://github.com/openkfw/TruBudget/blob/main/docs/developer/developer-setup.md

and running development setup guide here:
https://github.com/openkfw/TruBudget/blob/main/scripts/development/README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Indicates api related issue or feature feature Indicates a new feature implementation good first issue Good for newcomers
Projects
Development

No branches or pull requests

3 participants