https://github.com/bernardo-mg/dnd5-api-react-client
Example REST client made with React and Redux.
https://github.com/bernardo-mg/dnd5-api-react-client
example react rest
Last synced: 5 months ago
JSON representation
Example REST client made with React and Redux.
- Host: GitHub
- URL: https://github.com/bernardo-mg/dnd5-api-react-client
- Owner: Bernardo-MG
- License: mit
- Created: 2019-04-21T15:17:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T02:21:00.000Z (almost 2 years ago)
- Last Synced: 2025-07-30T13:02:13.657Z (6 months ago)
- Topics: example, react, rest
- Language: JavaScript
- Homepage: https://docs.bernardomg.com/react-rest-client-example
- Size: 1010 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# DnD5 API React Client
An example REST client made with React and Redux. Using the [DnD5e API][dnd5api].
## Features
- React + Redux
- REST queries
## Check it
There is an [online demo site][demo-site] which always reflects the latest version, taken from the master branch.
And a [development demo site][demo-site-development], taken from the development branch.
## Usage
### Prerequisites
- [npm][npm]
- Node
### 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:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
### Issues management
Issues are managed at the GitHub [project issues tracker][issues], 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][scm], 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][license].
[issues]: https://github.com/Bernardo-MG/dnd5-api-react-client/issues
[license]: http://www.opensource.org/licenses/mit-license.php
[npm]: https://www.npmjs.com/
[scm]: https://github.com/Bernardo-MG/dnd5-api-react-client
[dnd5api]: http://www.dnd5eapi.co/
[demo-site]: https://docs.bernardomg.com/dnd5-api-react-client
[demo-site-development]: https://docs.bernardomg.com/development/dnd5-api-react-client