{"id":20207370,"url":"https://github.com/okunaorg/okuna-js","last_synced_at":"2025-04-10T12:33:32.717Z","repository":{"id":35075520,"uuid":"203192450","full_name":"OkunaOrg/okuna-js","owner":"OkunaOrg","description":"🌈 Okuna API wrapper for the browser and Node","archived":false,"fork":false,"pushed_at":"2023-01-07T09:58:20.000Z","size":1666,"stargazers_count":16,"open_issues_count":21,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T10:51:42.793Z","etag":null,"topics":["api","client","javascript","okuna","okuna-js","social","typescript"],"latest_commit_sha":null,"homepage":"https://okunaorg.github.io/okuna-js/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OkunaOrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-19T14:46:28.000Z","updated_at":"2022-02-18T08:47:33.000Z","dependencies_parsed_at":"2023-01-15T13:18:43.731Z","dependency_job_id":null,"html_url":"https://github.com/OkunaOrg/okuna-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OkunaOrg%2Fokuna-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OkunaOrg%2Fokuna-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OkunaOrg%2Fokuna-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OkunaOrg%2Fokuna-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OkunaOrg","download_url":"https://codeload.github.com/OkunaOrg/okuna-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217145,"owners_count":21066633,"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":["api","client","javascript","okuna","okuna-js","social","typescript"],"created_at":"2024-11-14T05:28:42.850Z","updated_at":"2025-04-10T12:33:32.695Z","avatar_url":"https://github.com/OkunaOrg.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg alt=\"Okuna logo\" src=\"https://i.snag.gy/FAgp8K.jpg\" width=\"200\"\u003e\n\n[![npm version](https://img.shields.io/npm/v/okuna.svg?style=flat-square)](https://www.npmjs.com/package/okuna) [![CircleCI](https://circleci.com/gh/OkunaOrg/okuna-js/tree/master.svg?style=svg)](https://circleci.com/gh/OkunaOrg/okuna-js/tree/master) [![Maintainability](https://api.codeclimate.com/v1/badges/ac3ecb4e41ecfc2ecaf8/maintainability)](https://codeclimate.com/github/OkunaOrg/okuna-js/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/ac3ecb4e41ecfc2ecaf8/test_coverage)](https://codeclimate.com/github/OkunaOrg/okuna-js/test_coverage) [![gitmoji badge](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square)](https://github.com/carloscuesta/gitmoji)\n\nOkuna.js (beta) - A library for Node.js and the browser to connect to the Okuna API.\n\nThis library is currently in **public beta**, so errors might appear here and there. If you've stumbled upon an error, please [report it in the library's issue tracker](https://github.com/OkunaOrg/okuna-js/issues/new).\n\n## Table of Contents\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n    + [Code of Conduct](#code-of-conduct)\n    + [License](#license)\n    + [Other issues](#other-issues)\n    + [Git commit message conventions](#git-commit-message-conventions)\n- [Getting Started](#getting-started)\n\n## Requirements\n* [Node.js](https://nodejs.org/en/) (\u003e=8.x is recommended)\n* [okuna-api](https://github.com/OkunaOrg/okuna-api) for local development\n\n## Installation\n\nYou can install the library using npm:\n\n```\nnpm i okuna\n```\n\nor Yarn:\n\n```\nyarn add okuna\n```\n\n## Documentation\n\nYou can read the library documentation [here](https://okunaorg.github.io/okuna-js/).\n\n## Contributing\n\nThere are many different ways to contribute to the project's development, just find the one that best fits with your skills and open an issue/pull request in the repository.\n\nExamples of contributions we love include:\n\n- **Code patches**\n- **Bug reports**\n- **Patch reviews**\n\n#### Code of Conduct\n\nPlease read and follow our [Code of Conduct](https://github.com/OkunaOrg/okuna-js/blob/master/CODE_OF_CONDUCT.md).\n\n#### License\n\nEvery contribution accepted is licensed under [MIT](https://opensource.org/licenses/MIT) or any later version. \nYou must be careful to not include any code that can not be licensed under this license.\n\nPlease read carefully [our license](https://github.com/OkunaOrg/okuna-js/blob/master/LICENSE) and ask us if you have any questions.\n\n#### Responsible disclosure\n\nCyber-hero? Check out our [Vulnerability Disclosure page](https://www.okuna.io/en/vulnerability-report).\n\n#### Other issues\n\nWe're available almost 24/7 in the Okuna slack channel. [Join us!](https://join.slack.com/t/okunaorg/shared_invite/enQtNDI2NjI3MDM0MzA2LTYwM2E1Y2NhYWRmNTMzZjFhYWZlYmM2YTQ0MWEwYjYyMzcxMGI0MTFhNTIwYjU2ZDI1YjllYzlhOWZjZDc4ZWY)\n\n#### Git commit message conventions\n\nHelp us keep the repository history consistent 🙏!\n\nWe use [gitmoji](https://gitmoji.carloscuesta.me/) as our git message convention.\n\nIf you're using git in your command line, you can download the handy tool [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli).\n\n## Getting Started\n\n#### Clone the repository:\n\n```sh\ngit clone git@github.com:jozsefsallai/okuna.js.git\ncd okuna.js\n```\n\n#### Install the dependencies:\n\n```sh\nnpm install\n```\n\n#### To run a development build:\n\n```sh\nnpm run watch\n```\n\n#### To make a single build of the files:\n\n```sh\nnpm run build\n```\n\n#### To build for both Node and the browser, run:\n\n```sh\nnpm run prepare\n```\n\n#### Make sure that your changes pass linting:\n\n```sh\nnpm run lint\n```\n\n#### ...and that your tests are okay:\n\n```sh\nnpm run test\n```\n\n#### Happy coding 🎉!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokunaorg%2Fokuna-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokunaorg%2Fokuna-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokunaorg%2Fokuna-js/lists"}