102 lines
4.2 KiB
Markdown
102 lines
4.2 KiB
Markdown
# spiffworkflow-frontend
|
|
|
|
This is the frontend part of an app that leverages
|
|
[spiffworkflow](https://github.com/sartography/spiffworkflow) for managing and
|
|
running business processes. The backend portion can be found at
|
|
https://github.com/sartography/spiff-arena/tree/main/spiffworkflow-backend
|
|
|
|
This project was bootstrapped with [Create React
|
|
App](https://github.com/facebook/create-react-app), and the balance of this
|
|
README contains information about how to use apps that are bootstrapped with
|
|
that project.
|
|
|
|
## Available Scripts
|
|
|
|
In the project directory, you can run:
|
|
|
|
### `npm start`
|
|
|
|
Runs the app in the development mode.\
|
|
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
|
|
|
|
The page will reload when you make changes.\
|
|
You may also see any lint errors in the console.
|
|
|
|
### `npm test`
|
|
|
|
Launches the test runner in the interactive watch mode.\
|
|
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
|
|
|
### `npm run build`
|
|
|
|
Builds 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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
|
|
|
### `npm run eject`
|
|
|
|
**Note: 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.
|
|
|
|
### `npm run lint`
|
|
|
|
Check for lint in code.
|
|
|
|
### `npm run lint:fix`
|
|
|
|
Fix lint in code.
|
|
|
|
### `npm run format`
|
|
|
|
Probably just stick with lint:fix which also runs prettier.
|
|
|
|
## Runtime configuration options
|
|
|
|
The frontend docker image respects the following environment variables.
|
|
|
|
SPIFFWORKFLOW_FRONTEND_RUNTIME_CONFIG_APP_ROUTING_STRATEGY=subdomain_based
|
|
SPIFFWORKFLOW_FRONTEND_RUNTIME_CONFIG_APP_ROUTING_STRATEGY=path_based
|
|
|
|
subdomain_based example: api.spiffworkflow.org goes to backend
|
|
|
|
path_based example: spiffworkflow.org/api goes to backend
|
|
|
|
## Learn More
|
|
|
|
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
|
|
|
To learn React, check out the [React documentation](https://reactjs.org/).
|
|
|
|
### Code Splitting
|
|
|
|
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
|
|
|
|
### Analyzing the Bundle Size
|
|
|
|
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
|
|
|
|
### Making a Progressive Web App
|
|
|
|
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
|
|
|
|
### Advanced Configuration
|
|
|
|
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
|
|
|
|
### Deployment
|
|
|
|
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
|
|
|
|
### `npm run build` fails to minify
|
|
|
|
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
|