dcs-react-hooks

A React Utility Components Library for RCL developers
Explore the docs and code playground »

View Demo · Report Bug · Request Feature

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgments

About The Project

Purpose: @dcs-react-hooks-purpose

Problem: @dcs-react-hooks-problem

Scope: @dcs-react-hooks-scope

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

(back to top)

Built With

• React.js
• React Stylguidist

(back to top)

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

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

• Setup a React app using Create React App or React Styleguidist.

npx create-react-app dcs-react-hooks-app

• Add it to your React app or component library (inside your project path):

• yarn

yarn add dcs-react-hooks

• npm

npm i dcs-react-hooks

(back to top)

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.

(back to top)

Roadmap

• Return data fetched using url params
• Change path dynamically depending on app state

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

(back to top)

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.

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

(back to top)

License

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

(back to top)

Contact

@dcs-react-hooks-contact

Project Link: https://github.com/unfoldingword/dcs-react-hooks

(back to top)

Acknowledgments

• Abel Perez
• klappy

(back to top)