search

jembi / openhim-console

A webapp that provides a management console for the OpenHIM
http://openhim.org/
Mozilla Public License 2.0
12 stars 28 forks source link

Transaction Log Implementation #640

Closed ItsMurumba closed 4 weeks ago

ItsMurumba commented 2 months ago

This PR handle the basic setup of the Trasnaction Log Components. The tickets handled in this PR are:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update significantly enhances the OpenHIM Console by expanding API functionality, improving documentation, and introducing new components for transaction management. Key additions include a transaction log interface, improved routing for microfrontends, and robust configuration files for TypeScript and Babel. These changes aim to streamline development workflows and enhance user experience, making it easier for developers to manage transactions while also providing clear guidance in the documentation.

Changes

Files Change Summary
README.md Added "Tech Used" section, emphasized environment configuration, and included development access info.
packages/openhim-core-api/src/jembi-openhim-core-api.ts Introduced Transactions interface, new functions for fetching transactions and channels, and modified existing functions.
packages/root-config/src/index.ejs Added module import for @jembi/transaction-log for enhanced functionality.
packages/root-config/src/microfrontend-layout.html Added new routes for #!/transactionsxyz to integrate sidebar and transaction log applications.
packages/sidebar-app/src/menu.component.tsx Updated navigation links for transaction logs.
packages/transaction-log/.eslintrc Introduced ESLint configuration tailored for TypeScript and React.
packages/transaction-log/.gitignore Created .gitignore to exclude unnecessary files from version control.
packages/transaction-log/.prettierignore Introduced .prettierignore to specify files to be excluded from Prettier formatting.
packages/transaction-log/babel.config.json Established Babel configuration for JSX and TypeScript.
packages/transaction-log/jest.config.js Configured Jest for testing environment with support for React and TypeScript.
packages/transaction-log/package.json Set up scripts for development, testing, and added key dependencies.
packages/transaction-log/src/app.css Added styles for the application body.
packages/transaction-log/src/components/App.tsx Created main component for managing transaction logs with filtering capabilities.
packages/transaction-log/src/components/BasicFilters.tsx Implemented filtering UI for transaction logs with various criteria.
packages/transaction-log/src/components/CustomFilters.tsx Developed additional filtering options for transactions.
packages/transaction-log/src/components/TransactionLogTable.tsx Created table component to display transactions dynamically.
packages/transaction-log/src/declarations.d.ts Added TypeScript declarations for image imports and external modules.
packages/transaction-log/src/jembi-transaction-log.tsx Integrated transaction log as a microfrontend with lifecycle management.
packages/transaction-log/src/root.component.tsx Established root component for transaction log features.
packages/transaction-log/tsconfig.json Introduced TypeScript configuration tailored for SPA development.
packages/transaction-log/webpack.config.js Configured Webpack for project build process.

Poem

🐇 In the garden where code does bloom,
New features leap and old bugs zoom.
With logs and filters, oh what a sight,
OpenHIM's journey takes flight!
So hop along, let’s build and grow,
In this digital meadow, our skills will show!
🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
drizzentic commented 1 month ago

@coderabbitai review

coderabbitai[bot] commented 1 month ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.