{"id":20237056,"url":"https://github.com/ronin-co/client","last_synced_at":"2025-04-10T19:12:08.603Z","repository":{"id":236370778,"uuid":"792302207","full_name":"ronin-co/client","owner":"ronin-co","description":"Access RONIN via TypeScript.","archived":false,"fork":false,"pushed_at":"2024-05-29T14:59:43.000Z","size":5314,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-05-30T02:12:52.861Z","etag":null,"topics":["bun","client","data","javascript","js","library","node","nodejs","query","ts","typescript"],"latest_commit_sha":null,"homepage":"https://ronin.co/docs/typescript-client","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ronin-co.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-26T11:46:01.000Z","updated_at":"2024-06-12T18:20:08.649Z","dependencies_parsed_at":"2024-05-31T16:11:18.758Z","dependency_job_id":null,"html_url":"https://github.com/ronin-co/client","commit_stats":null,"previous_names":["ronin-co/client"],"tags_count":175,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ronin-co%2Fclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ronin-co","download_url":"https://codeload.github.com/ronin-co/client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248279806,"owners_count":21077408,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bun","client","data","javascript","js","library","node","nodejs","query","ts","typescript"],"created_at":"2024-11-14T08:24:29.729Z","updated_at":"2025-04-10T19:12:08.597Z","avatar_url":"https://github.com/ronin-co.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RONIN Client\n\n[![tests](https://img.shields.io/github/actions/workflow/status/ronin-co/client/validate.yml?label=tests)](https://github.com/ronin-co/client/actions/workflows/validate.yml)\n[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/client)](https://codecov.io/github/ronin-co/client)\n[![install size](https://packagephobia.com/badge?p=ronin)](https://packagephobia.com/result?p=ronin)\n\nThis package allows for querying data from [RONIN](https://ronin.co) with ease.\n\n## Setup\n\nFirst, install the [package](https://www.npmjs.com/package/ronin) with a package manager of your choice:\n\n```bash\n# Bun\nbun add ronin\n\n# npm\nnpm install ronin\n```\n\nNext, create a new app token on the [RONIN dashboard](http://ronin.co) (under \"Apps\" in the sidebar), and add it as a environment variable named `RONIN_TOKEN` to your project.\n\nAfterward, you can start invoking RONIN from anywhere in your code:\n\n```typescript\nimport { get } from 'ronin';\n\nconst posts = await get.posts();\n```\n\nThat's it! 🎉\n\nYou can now start inserting records with the [RONIN query syntax](https://ronin.co/docs/queries), or add them on the [RONIN dashboard](http://ronin.co). Everything you can do with the RONIN client, you can also do on the dashboard (creating records, retrieving them, filtering them, updating them, etc).\n\n## Contributing\n\nWe would be excited to welcome your suggestions for the RONIN client!\n\nTo start contributing code, first make sure you have [Bun](https://bun.sh) installed, which is a JavaScript runtime.\n\nNext, [clone the repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) and install its dependencies:\n\n```bash\nbun install\n```\n\nOnce that's done, link the package to make it available to all of your local projects:\n\n```bash\nbun link\n```\n\nInside your project, you can then run the following command, which is similar to `bun add ronin` or `npm install ronin`, except that it doesn't install `ronin` from npm, but instead uses your local clone of the package:\n\n```bash\nbun link ronin\n```\n\nIf your project is not yet compatible with [Bun](https://bun.sh), feel free to replace all of the occurances of the word `bun` in the commands above with `npm` instead.\n\nYou will just need to make sure that, once you [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#creating-the-pull-request) on the current repo, it will not contain a `package-lock.json` file, which is usually generated by npm. Instead, we're using the `bun.lock` file for this purpose (locking sub dependencies to a certain version).\n\n### Developing\n\nIn order to be compatible with a wide range of projects, the source code of the `client` repo needs to be compiled (transpiled) whenever you make changes to it. To automate this, you can keep this command running in your terminal:\n\n```bash\nbun run dev\n```\n\nWhenever you make a change to the source code, it will then automatically be transpiled again.\n\n### Running Tests\n\nThe RONIN client has 100% test coverage, which means that every single line of code is tested automatically, to ensure that any change to the source code doesn't cause a regression.\n\nBefore you create a pull request on the `client` repo, it is therefore advised to run those tests in order to ensure everything works as expected:\n\n```bash\n# Run all tests\nbun test\n\n# Alternatively, run a single test\nbun test -t 'your test name'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fronin-co%2Fclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fronin-co%2Fclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fronin-co%2Fclient/lists"}