First of all, thanks for considering contributing to this project! If you have any questions please don't hesitate to reach out to eric@jsonhero.io or join us on Discord.
JSON Hero is a Typescript React application built with remix.run, with support for deploying to Cloudflare workers.
To get started with contributing, please read our Development guide first to get JSON Hero running locally.
Although there is less test-coverage for JSON Hero than there should be, tests should still be run to ensure builds have not been broken:
npm testYou can also run tests in "watch" mode:
npm run test:watchPlease make any changes to your forked repository in a branch other than main. If you are working on a bug fix, please use the bug/ prefix for your branch name. If you are working on a feature, please use features/. If you are working on a specific issue please name the branch issue-<issue number>
Make sure to run the npm lint command to ensure there are no Typescript compile-time errors.
Please open a Pull Request against the main branch in the apihero-run/jsonhero-web repository. We will aim to address all newly opened PRs by the following Friday. If you haven't opened a Pull Request before, please check out GitHub's Pull Request documentation
If you'd like to contribute to the VSCode extension, please see the apihero-run/vscode-extension repo.
For issues related to the JSON Schema inference, please check out apihero-run/schema-infer.
The "Smart Preview" feature is in-part powered by the @jsonhero/json-infer-types project.
If it's related to the Search functionality, please see the apihero-run/fuzzy-json-search repo.