npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

okuna

v0.3.0

Published

Node.js API bindings for the Okuna social network.

Downloads

15

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jozsefsallaijozsefsallai

Keywords

okunasocialnetworkapi

Readme

npm version CircleCI Maintainability Test Coverage gitmoji badge

Okuna.js (beta) - A library for Node.js and the browser to connect to the Okuna API.

This 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.

Table of Contents

Requirements

Installation

You can install the library using npm:

npm i okuna

or Yarn:

yarn add okuna

Documentation

You can read the library documentation here.

Contributing

There 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.

Examples of contributions we love include:

  • Code patches
  • Bug reports
  • Patch reviews

Code of Conduct

Please read and follow our Code of Conduct.

License

Every contribution accepted is licensed under MIT or any later version. You must be careful to not include any code that can not be licensed under this license.

Please read carefully our license and ask us if you have any questions.

Responsible disclosure

Cyber-hero? Check out our Vulnerability Disclosure page.

Other issues

We're available almost 24/7 in the Okuna slack channel. Join us!

Git commit message conventions

Help us keep the repository history consistent 🙏!

We use gitmoji as our git message convention.

If you're using git in your command line, you can download the handy tool gitmoji-cli.

Getting Started

Clone the repository:

git clone [email protected]:jozsefsallai/okuna.js.git
cd okuna.js

Install the dependencies:

npm install

To run a development build:

npm run watch

To make a single build of the files:

npm run build

To build for both Node and the browser, run:

npm run prepare

Make sure that your changes pass linting:

npm run lint

...and that your tests are okay:

npm run test

Happy coding 🎉!