The frontend web-app is a React HTML5 application that serves as a UI for backend services.
This project was bootstrapped with Create React App.
The entry point is at src/index.tsx.
Node version >= 12
Before starting development, install dependencies with npm:
npm ci
Backend services urls, as well as other configurations are injected into the app as environment variables.
The application automatically reads any environment variables specified in file called .env.
To specify these variables. Create the .env file as follows:
REACT_APP_NEWS_ENABLED=1
REACT_APP_ADOPTION_SERVICE_URL=http://localhost:8080
REACT_APP_ANIMAL_SERVICE_URL=http://localhost:8081
REACT_APP_SHELTER_SERVICE_URL=http://localhost:8082
Note that if urls for the backend services are not provided, the web-app will use fake data instead.
In production. The environments can be passed to the container, as specified in the Dockerfile.
npm startRuns the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
npm testLaunches the test runner in the interactive watch mode.
See the section about running tests for more information.
npm buildBuilds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
npm run start:prodStarts the production server by executing server.js.
The production server serves the files at web-app/build. This is the production build of the web-app.
The production server also injects environment variables at run-time into web-app/build/index.html so that they can be read by the web-app.
The injected environment variables must start with the REACT_APP_ prefix.
npm run lintChecks and fixes (when possible) coding style errors.
The coding style is specified in the .eslintrc.json file.
npm ejectNote: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can generate production images for 1.0 and 2.0 version of the application.
To build 1.0, run ./scripts/build_image_v1.
To build 2.0, run ./scripts/build_image_v2.
To push the generated images to quay, run podman push quay.io/redhattraining/ossm-adopt-a-pup-webapp.
You can learn more in the Create React App documentation.