{"id":19693766,"url":"https://github.com/jhipster/jhipster-sample-app-react","last_synced_at":"2025-05-16T14:04:49.090Z","repository":{"id":41583642,"uuid":"113914285","full_name":"jhipster/jhipster-sample-app-react","owner":"jhipster","description":"This is a sample application created with JHipster, using React","archived":false,"fork":false,"pushed_at":"2025-04-01T03:28:40.000Z","size":10784,"stargazers_count":218,"open_issues_count":1,"forks_count":98,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-05-06T21:40:42.911Z","etag":null,"topics":["java","jhipster","react"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jhipster.png","metadata":{"funding":{"open_collective":"generator-jhipster","custom":"https://www.jhipster.tech/sponsors/"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-12-11T22:14:15.000Z","updated_at":"2025-04-01T03:28:44.000Z","dependencies_parsed_at":"2024-03-28T16:55:10.710Z","dependency_job_id":"fe1b3ccd-ba55-4929-b550-6b4944807067","html_url":"https://github.com/jhipster/jhipster-sample-app-react","commit_stats":{"total_commits":115,"total_committers":6,"mean_commits":"19.166666666666668","dds":0.5217391304347826,"last_synced_commit":"9411d6c2d5e2c448828eec1fc25978c03710628f"},"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhipster%2Fjhipster-sample-app-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhipster%2Fjhipster-sample-app-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhipster%2Fjhipster-sample-app-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhipster%2Fjhipster-sample-app-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhipster","download_url":"https://codeload.github.com/jhipster/jhipster-sample-app-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","jhipster","react"],"created_at":"2024-11-11T19:18:01.224Z","updated_at":"2025-05-16T14:04:49.083Z","avatar_url":"https://github.com/jhipster.png","language":"Java","readme":"# jhipsterSampleApplicationReact\n\nThis application was generated using JHipster 8.11.0, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v8.11.0](https://www.jhipster.tech/documentation-archive/v8.11.0).\n\n## Project Structure\n\nNode is required for generation and recommended for development. `package.json` is always generated for a better development experience with prettier, commit hooks, scripts and so on.\n\nIn the project root, JHipster generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.\n\n`/src/*` structure follows default Java structure.\n\n- `.yo-rc.json` - Yeoman configuration file\n  JHipster configuration is stored in this file at `generator-jhipster` key. You may find `generator-jhipster-*` for specific blueprints configuration.\n- `.yo-resolve` (optional) - Yeoman conflict resolver\n  Allows to use a specific action when conflicts are found skipping prompts for files that matches a pattern. Each line should match `[pattern] [action]` with pattern been a [Minimatch](https://github.com/isaacs/minimatch#minimatch) pattern and action been one of skip (default if omitted) or force. Lines starting with `#` are considered comments and are ignored.\n- `.jhipster/*.json` - JHipster entity configuration files\n\n- `npmw` - wrapper to use locally installed npm.\n  JHipster installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using `./npmw` instead of the traditional `npm` you can configure a Node-less environment to develop or test your application.\n- `/src/main/docker` - Docker configurations for the application and services that the application depends on\n\n## Development\n\nThe build system will install automatically the recommended version of Node and npm.\n\nWe provide a wrapper to launch npm.\nYou will only need to run this command when dependencies change in [package.json](package.json).\n\n```\n./npmw install\n```\n\nWe use npm scripts and [Webpack][] as our build system.\n\nRun the following commands in two separate terminals to create a blissful development experience where your browser\nauto-refreshes when files change on your hard drive.\n\n```\n./mvnw\n./npmw start\n```\n\nNpm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by\nspecifying a newer version in [package.json](package.json). You can also run `./npmw update` and `./npmw install` to manage dependencies.\nAdd the `help` flag on any command to see how you can use it. For example, `./npmw help update`.\n\nThe `./npmw run` command will list all the scripts available to run for this project.\n\n### PWA Support\n\nJHipster ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.\n\nThe service worker initialization code is commented out by default. To enable it, uncomment the following code in `src/main/webapp/index.html`:\n\n```html\n\u003cscript\u003e\n  if ('serviceWorker' in navigator) {\n    navigator.serviceWorker.register('./service-worker.js').then(function () {\n      console.log('Service Worker Registered');\n    });\n  }\n\u003c/script\u003e\n```\n\nNote: [Workbox](https://developers.google.com/web/tools/workbox/) powers JHipster's service worker. It dynamically generates the `service-worker.js` file.\n\n### Managing dependencies\n\nFor example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:\n\n```\n./npmw install --save --save-exact leaflet\n```\n\nTo benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:\n\n```\n./npmw install --save-dev --save-exact @types/leaflet\n```\n\nThen you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:\nNote: There are still a few other things remaining to do for Leaflet that we won't detail here.\n\nFor further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].\n\n## Building for production\n\n### Packaging as jar\n\nTo build the final jar and optimize the jhipsterSampleApplicationReact application for production, run:\n\n```\n./mvnw -Pprod clean verify\n```\n\nThis will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.\nTo ensure everything worked, run:\n\n```\njava -jar target/*.jar\n```\n\nThen navigate to [http://localhost:8080](http://localhost:8080) in your browser.\n\nRefer to [Using JHipster in production][] for more details.\n\n### Packaging as war\n\nTo package your application as a war in order to deploy it to an application server, run:\n\n```\n./mvnw -Pprod,war clean verify\n```\n\n### JHipster Control Center\n\nJHipster Control Center can help you manage and control your application(s). You can start a local control center server (accessible on http://localhost:7419) with:\n\n```\ndocker compose -f src/main/docker/jhipster-control-center.yml up\n```\n\n## Testing\n\n### Spring Boot tests\n\nTo launch your application's tests, run:\n\n```\n./mvnw verify\n```\n\n### Gatling\n\nPerformance tests are run by [Gatling][] and written in Scala. They're located in [src/test/java/gatling/simulations](src/test/java/gatling/simulations).\n\nYou can execute all Gatling tests with\n\n```\n./mvnw gatling:test\n```\n\n### Client tests\n\nUnit tests are run by [Jest][]. They're located near components and can be run with:\n\n```\n./npmw test\n```\n\nUI end-to-end tests are powered by [Cypress][]. They're located in [src/test/javascript/cypress](src/test/javascript/cypress)\nand can be run by starting Spring Boot in one terminal (`./mvnw spring-boot:run`) and running the tests (`./npmw run e2e`) in a second one.\n\n#### Lighthouse audits\n\nYou can execute automated [Lighthouse audits](https://developers.google.com/web/tools/lighthouse/) with [cypress-audit](https://github.com/mfrachet/cypress-audit) by running `./npmw run e2e:cypress:audits`.\nYou should only run the audits when your application is packaged with the production profile.\nThe lighthouse report is created in `target/cypress/lhreport.html`\n\n## Others\n\n### Code quality using Sonar\n\nSonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:\n\n```\ndocker compose -f src/main/docker/sonar.yml up -d\n```\n\nNote: we have turned off forced authentication redirect for UI in [src/main/docker/sonar.yml](src/main/docker/sonar.yml) for out of the box experience while trying out SonarQube, for real use cases turn it back on.\n\nYou can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) or by using the maven plugin.\n\nThen, run a Sonar analysis:\n\n```\n./mvnw -Pprod clean verify sonar:sonar -Dsonar.login=admin -Dsonar.password=admin\n```\n\nIf you need to re-run the Sonar phase, please be sure to specify at least the `initialize` phase since Sonar properties are loaded from the sonar-project.properties file.\n\n```\n./mvnw initialize sonar:sonar -Dsonar.login=admin -Dsonar.password=admin\n```\n\nAdditionally, Instead of passing `sonar.password` and `sonar.login` as CLI arguments, these parameters can be configured from [sonar-project.properties](sonar-project.properties) as shown below:\n\n```\nsonar.login=admin\nsonar.password=admin\n```\n\nFor more information, refer to the [Code quality page][].\n\n### Docker Compose support\n\nJHipster generates a number of Docker Compose configuration files in the [src/main/docker/](src/main/docker/) folder to launch required third party services.\n\nFor example, to start required services in Docker containers, run:\n\n```\ndocker compose -f src/main/docker/services.yml up -d\n```\n\nTo stop and remove the containers, run:\n\n```\ndocker compose -f src/main/docker/services.yml down\n```\n\n[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enabled by default. It's possible to disable it in application.yml:\n\n```yaml\nspring:\n  ...\n  docker:\n    compose:\n      enabled: false\n```\n\nYou can also fully dockerize your application and all the services that it depends on.\nTo achieve this, first build a Docker image of your app by running:\n\n```sh\nnpm run java:docker\n```\n\nOr build a arm64 Docker image when using an arm64 processor os like MacOS with M1 processor family running:\n\n```sh\nnpm run java:docker:arm64\n```\n\nThen run:\n\n```sh\ndocker compose -f src/main/docker/app.yml up -d\n```\n\nFor more information refer to [Using Docker and Docker-Compose][], this page also contains information on the Docker Compose sub-generator (`jhipster docker-compose`), which is able to generate Docker configurations for one or several JHipster applications.\n\n## Continuous Integration (optional)\n\nTo configure CI for your project, run the ci-cd sub-generator (`jhipster ci-cd`), this will let you generate configuration files for a number of Continuous Integration systems. Consult the [Setting up Continuous Integration][] page for more information.\n\n[JHipster Homepage and latest documentation]: https://www.jhipster.tech\n[JHipster 8.11.0 archive]: https://www.jhipster.tech/documentation-archive/v8.11.0\n[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/v8.11.0/development/\n[Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/v8.11.0/docker-compose\n[Using JHipster in production]: https://www.jhipster.tech/documentation-archive/v8.11.0/production/\n[Running tests page]: https://www.jhipster.tech/documentation-archive/v8.11.0/running-tests/\n[Code quality page]: https://www.jhipster.tech/documentation-archive/v8.11.0/code-quality/\n[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/v8.11.0/setting-up-ci/\n[Node.js]: https://nodejs.org/\n[NPM]: https://www.npmjs.com/\n[Gatling]: https://gatling.io/\n[Webpack]: https://webpack.github.io/\n[BrowserSync]: https://www.browsersync.io/\n[Jest]: https://jestjs.io\n[Cypress]: https://www.cypress.io/\n[Leaflet]: https://leafletjs.com/\n[DefinitelyTyped]: https://definitelytyped.org/\n","funding_links":["https://opencollective.com/generator-jhipster","https://www.jhipster.tech/sponsors/"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhipster%2Fjhipster-sample-app-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhipster%2Fjhipster-sample-app-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhipster%2Fjhipster-sample-app-react/lists"}