spiff-arena/spiffworkflow-frontend
Kevin Burnett 7c8d9e2db1
Feature/tcoz dev updated (#1051)
* Update README.md

Some notes for people that might want to run full-on native, with detail about how Mac hijacks port 7000 and how to get around it.

* Revert "Update README.md"

This reverts commit 096887c26d.

* README update and native code patch

Some details for user that might be running Python3, Mac, and want to run everything locally/natively.

* Implement basic tooltips

Uses MUI tooltip, as it behaves more predictably with existing styling, and enables top-level theme config.

Top-level configuration for all MUI components can be controlled via overriding the existing theme. See index.tsx. This could be done per user for customization, etc.

Enabling JSON module imports in tsconfig.json seemed to fix the error in ReactDiagramEditor

* get docs from main that have already been merged from tcoz and tweaked

* created SpiffTooltip component so we can change how tooltips operate across the board w/ burnettk

* update tooltip title copy

* remove arrow not needed in caller

* types and wording

---------

Co-authored-by: Tim Consolazio <tcoz@tcoz.com>
Co-authored-by: burnettk <burnettk@users.noreply.github.com>
Co-authored-by: jasquat <jasquat@users.noreply.github.com>
2024-02-16 07:02:45 -08:00
..
.github check that connector-proxy-demo can run when releasing new tags w/ burnettk 2023-12-06 11:21:32 -05:00
bin added script in frontend to use local version of bpmn-js-spiffworkflow w/ burnettk 2023-08-31 16:27:02 -04:00
cypress update bpmn-js-spiffworkflow (#903) 2024-01-30 08:54:05 -08:00
public run_pyl, and a little cleanup. 2023-05-16 15:29:43 -04:00
src Feature/tcoz dev updated (#1051) 2024-02-16 07:02:45 -08:00
.dockerignore
.eslintignore moved carbon theme items around w/ burnettk 2023-05-31 15:16:51 -04:00
.eslintrc.js Feature/pi show page diagram (#816) 2023-12-18 14:23:51 -05:00
.gitignore some updates for NDR_PP1 cypress tests w/ burnettk 2023-05-10 15:49:55 -04:00
.prettierrc.js
.tool-versions
Dockerfile curl and procps in container for debugging (#680) 2023-11-16 07:18:11 -08:00
LICENSE.rst
README.md fix some links 2024-02-11 12:28:57 -05:00
craco.config.js
cypress.config.js upgraded cypress and moved code in helpers to ensure we do not need app code for cypress w/ burnettk (#431) 2023-08-03 15:08:45 -04:00
cypress.env.json
docker-compose.yml
justservewebserver.package.json
package-lock.json Bump @testing-library/react in /spiffworkflow-frontend (#1053) 2024-02-16 14:38:57 +00:00
package.json Bump @testing-library/react in /spiffworkflow-frontend (#1053) 2024-02-16 14:38:57 +00:00
sonar-project.properties
tsconfig.json Feature/tcoz dev updated (#1051) 2024-02-16 07:02:45 -08:00

README.md

spiffworkflow-frontend

This is the frontend part of an app that leverages 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, 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 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 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 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.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: 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

Making a Progressive Web App

This section has moved here: 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

Deployment

This section has moved here: 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