https://github.com/jhipster/react-jhipster
JHipster React library
https://github.com/jhipster/react-jhipster
jhipster react
Last synced: 6 months ago
JSON representation
JHipster React library
- Host: GitHub
- URL: https://github.com/jhipster/react-jhipster
- Owner: jhipster
- License: apache-2.0
- Created: 2017-10-06T09:30:30.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-31T12:56:38.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T00:55:42.488Z (11 months ago)
- Topics: jhipster, react
- Language: TypeScript
- Size: 2.24 MB
- Stars: 83
- Watchers: 22
- Forks: 118
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Logo][jhipster-image]][jhipster-url]
Greetings, Java Hipster!
This is the JHipster React utilities library
[![NPM version][npm-image]][npm-url]
[![Build Status][github-actions-image]][github-actions-url]
Full documentation and information is available on our website at [http://www.jhipster.tech/][jhipster-url]
Please read our [guidelines](https://github.com/jhipster/generator-jhipster/CONTRIBUTING.md#submitting-an-issue) before submitting an issue. If your issue is a bug, please use the bug template pre populated [here](https://github.com/jhipster/generator-jhipster/issues/new). For feature requests and queries you can use [this template][feature-template].
[github-actions-image]: https://github.com/jhipster/react-jhipster/actions/workflows/ci.yml/badge.svg
[github-actions-url]: https://github.com/jhipster/react-jhipster/actions/workflows/ci.yml
[jhipster-image]: https://raw.githubusercontent.com/jhipster/jhipster.github.io/main/images/logo/logo-jhipster2x.png
[jhipster-url]: http://www.jhipster.tech/
[npm-image]: https://badge.fury.io/js/react-jhipster.svg
[npm-url]: https://npmjs.org/package/react-jhipster
[feature-template]: https://github.com/jhipster/generator-jhipster/issues/new?body=*%20**Overview%20of%20the%20request**%0A%0A%3C!--%20what%20is%20the%20query%20or%20request%20--%3E%0A%0A*%20**Motivation%20for%20or%20Use%20Case**%20%0A%0A%3C!--%20explain%20why%20this%20is%20a%20required%20for%20you%20--%3E%0A%0A%0A*%20**Browsers%20and%20Operating%20System**%20%0A%0A%3C!--%20is%20this%20a%20problem%20with%20all%20browsers%20or%20only%20IE8%3F%20--%3E%0A%0A%0A*%20**Related%20issues**%20%0A%0A%3C!--%20has%20a%20similar%20issue%20been%20reported%20before%3F%20--%3E%0A%0A*%20**Suggest%20a%20Fix**%20%0A%0A%3C!--%20if%20you%20can%27t%20fix%20this%20yourself%2C%20perhaps%20you%20can%20point%20to%20what%20might%20be%0A%20%20causing%20the%20problem%20(line%20of%20code%20or%20commit)%20--%3E
## Development setup
You need NodeJS and NPM.
### Fork the react-jhipster project
Go to the [react-jhipster project](https://github.com/jhipster/react-jhipster) and click on the "fork" button. You can then clone your own fork of the project, and start working on it.
[Please read the Github forking documentation for more information](https://help.github.com/articles/fork-a-repo)
### Build
Run `npm install` to install all dependencies.
Make some changes, run `npm run test` to run both eslint and karma tests.
Package the library with `npm run build`.
### Set NPM to use the cloned project
In your cloned `react-jhipster` project, type `npm link`.
This will do a symbolic link from the global `node_modules` version to point to this folder.
For testing, you will want to integrate your version of `react-jhipster` into an application generated by JHipster.
Go to your application folder, run `npm link react-jhipster` so that the local version has a symbolic link to the development version of `react-jhipster`.
You should see your changes reflected in the application.
Another way is to run `npm pack` on react-jhipster and then do `npm install path-to/react-jhipster/react-jhipster-0.15.0.tgz` on the generated application. this is the most fool proof way to test if `npm link` doesn't work