ui5-webcomponents-react-seed decrease’s the bootstrap time spent on new projects, POCs or MVPs which uses React + UI5 WebComponents React by leveraging several out-of-the-box components, scripts & configurations.
For more info, check this link here.
- open the terminal;
npx create-react-app PROJECT_NAME --template ui5-webcomponents-react-seed;- cd into
PROJECT_NAME; - run
node post_create.jsto add Husky and move some dependencies to devDependencies (both are limitations ofcreate-react-app) - (no need to run
yarn installsince it already installs it for you); - run the available scripts.
PS.: It is important to add the --template ui5-webcomponents-react-seed at the end to get our template.
-
JEST Up & Runnning;
-
ESLint & EditorConfig Up & Running;
-
CommitLint Up & Running;
-
Enviroment Variables Up & Running;
-
Internalization Up & Running;
-
PR Template;
-
IE Support;
-
Multiple Scripts.
-
Fallback Engine (
<ErrorBoundary />,<NotFound />and<Error />); -
MockServer Engine (w/
json-server); -
API HTTP Request Engine (w/
Request,APIProvider,BrowserProvider); -
Permission Engine (w/
RouteValidatorandComponentValidator). -
Pagination Engine (w/ custom hook
usePaginatedGet). -
ToDo Form Edition w/
yupandformik.
-
useRequest: Which includesget,post,patch,delete,putHTTP helpers; -
useAuthority: Which includeshasAccesshelpers.
Following one of the several recommendations for structuring files on a React based project, the seed use: Grouping by file type.
The only custom change we have incremented were the Custom Components and the folder for each project containing the tests artefacts.
In the project directory, you can run:
Runs the app in the development mode @ http://localhost:3000.
<domain>:<port>/api.
Runs the app in the development mode @ http://localhost:3001 w/ json-server.
Launches the test runner in the interactive watch mode.
Executes the test runner without the interactive watch mode.
Executes the test runner and generates the report.
Checks all the files of the project according to the .eslintrc.js pre stablished configuration.
Fixes all the files of the project according to the .eslintrc.js pre stablished configuration.
Checks all the files of the project according to the .prettierrc pre stablished configuration.
Fixes all the files of the project according to the .prettierrc pre stablished configuration.
Builds the app for production to the build folder.
This will help you when building the JSX files by renaming the closing for you.
This will help you to use the defined coding style at the .editoronfig file during development.
This will help you to use the defined coding style at the .eslintrc file during development.
This will help you run and debug your *.test.js file during file during test-development.
This will help you better see the folders and files icons according to its extensions/subject.
This will enforces a consistent style by parsing your code and re-printing it with its own rules, wrapping code when necessary.
Autocomplete/Intelissense your testing methods from the JEST lib.
Used to manipulate async request, data fetching, cache and more (no redux / saga anymore).
Tutorial Link, Random Post and Creator Official Video.
Used to manpilate DOM attributes through JSX such as <head>.
Used to translate strings and text in the application following the Internationalization pattern.
Used to identify the browsers culture and change the applications text accordingly.
Used to identify the device, browser, ratios and etc.
Used to help developers during the React Query information flow.
Used to check the commits before actually commits.
Used for embed the enviroment variables during the API URL build.
Used to provide a checker before actions.
Used to update the files without restarting the server.
Used to run multiple commands without worrying about OS syntax.
Used to support old browsers.
Used to support jest and its scripts with the new engine.
Take a look into our Kanban Board here.