Bernardo-MG / dnd5-api-react-client

Example REST client made with React and Redux.
https://docs.bernardomg.com/react-rest-client-example
MIT License
1 stars 0 forks source link
example react rest

DnD5 API React Client

An example REST client made with React and Redux. Using the DnD5e API.

Features

Check it

There is an online demo site which always reflects the latest version, taken from the master branch.

And a development demo site, taken from the development branch.

Usage

Prerequisites

Building the project

First of all install the dependencies:

npm install

Then there are two options for building the project.

You can create a development version:

npm run development

Or a production version:

npm run build

Running tests

There is a script ready for running tests:

npm run test

Deploying locally

Once the project has been built it can be deployed locally for testing:

npm run start

Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

Issues management

Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.

Getting the code

If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.

License

The project has been released under the MIT License.