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

proskomma-react-hooks

v2.4.0-rc.1

Published

A collection of React Hooks that provide a way to simplify the implementation of Proskomma into your React projects.

Downloads

229

Readme

Contributors Forks Stargazers Issues MIT License

About The Project

Product Name Screen Shot

Purpose: A collection of React Hooks that provide a way to simplify the implementation of Proskomma into your React projects.

Problem: Proskomma.js is a very powerful tool but has a fairly steep learning curve to setup and get running.

Scope: This project aims to simplify the implementing of Proskomma.js into our projects and especially the common use cases. It includes bootstrapping, importing and common queries/filters of Proskomma.

This project does not cover the downloading or obtaining of files to import.

Background: We implemented Proskomma.js in a few early projects but found it taking too long to setup and too much specific domain knowledge to make it useful. We kept refactoring our common use cases into this project as custom hooks and have a single place to maintain them.

Architecture and Design Principles: See ARCHITECTURE.md for details on architecture and design principles for this project.

Built With

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Data The source of the data to import into Proskomma are scripture files such as USFM.

Testing files can be generated using Lorem Ipsum USFM.

Real USFM files can be found in multiple places such as:

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation/First Steps

  1. Setup a React app using Create React App or React Styleguidist.
npx create-react-app proskomma-react-hooks-app
  1. Add it to your React app or component library (inside your project path):
  • yarn
yarn add proskomma-react-hooks
  • npm
npm i proskomma-react-hooks
  1. Bootstrap inside App.jsx with useProskomma.
  2. Import: Create a new component for Importing data useImport.
  3. Passage: Create a new component for Passage Lookup and use custom hook inside it via usePassage.
  4. Search: Create a new component for Search and use custom hook inside it via useSearchForPassages
  5. Customize and run your own query useQuery

Usage/Integration

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Styleguidist.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Chris Klapp aka Klappy - [email protected]

Project Link: https://github.com/unfoldingWord/proskomma-react-hooks

Acknowledgments