cra-template-react-redux-toolkit
Advanced tools
Comparing version 0.2.7 to 0.2.8
{ | ||
"name": "cra-template-react-redux-toolkit", | ||
"version": "0.2.7", | ||
"version": "0.2.8", | ||
"eslintConfig": { | ||
@@ -5,0 +5,0 @@ "extends": [ |
# Create React App with Redux-Toolkit including MUI | ||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app) and Redux-Toolkit including MUI. | ||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app) and includes Redux-Toolkit along with Material-UI (MUI) for styling. | ||
## Use template | ||
To create a new project using this template, execute the following command: | ||
``` | ||
npx create-react-app my-app --template react-redux-toolkit | ||
``` | ||
Once the project is created, navigate to the project directory and you can use the following scripts: | ||
### `npm run api` | ||
This command runs the JSON server, which provides mock APIs. You can access the server at [http://localhost:3001](http://localhost:3001). The JSON server is used for demonstration purposes, and you can check the TODO app after it's up and running. | ||
### `npm start` | ||
This command runs the app in development mode. You can access the app in your browser at [http://localhost:3000](http://localhost:3000). | ||
## TODOs | ||
1) Dummy Logo image | ||
2) MUI dark / light theme | ||
3) Localization | ||
4) If need , apply MUI component to Counter & Todo features | ||
5) If need , Keycloak & Authorization (implementation as comments to uncomment) | ||
Here are some tasks that need to be completed or ideas to consider for the project: | ||
1) **Localization:** Implement localization to support multiple languages in the app. | ||
2) **Keycloak & Authorization:** Consider implementing Keycloak for authentication and authorization. There might be comments in the code that guide you through the setup. Also, I've another library to simplify this setup, but please note that it might not be up to date. | ||
3) **Other Authentication / Authorization Ideas:** Explore additional ideas and best practices related to authentication and authorization, such as using OAuth, JWT, or other security mechanisms. | ||
4) **Redux Persist:** Consider implementing Redux Persist to persist the Redux store across sessions, ensuring data retention and improving the user experience. | ||
Please feel free to enhance the project based on these tasks and ideas. If you have any specific sections you'd like me to focus on, please let me know, and I'll be happy to further fine-tune the document. |
@@ -1,81 +0,36 @@ | ||
# Getting Started with Create React App | ||
# Create React App with Redux-Toolkit including MUI | ||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app) and includes Redux-Toolkit along with Material-UI (MUI) for styling. | ||
## Use template | ||
* Redux Toolkit (API Slices, Cache tags) | ||
* MUI library | ||
To create a new project using this template, execute the following command: | ||
## Available Scripts | ||
``` | ||
npx create-react-app my-app --template react-redux-toolkit | ||
In the project directory, you can run: | ||
``` | ||
Once the project is created, navigate to the project directory and you can use the following scripts: | ||
### `npm run api` | ||
Runs the JSON server.\ | ||
You can point [http://localhost:3001](http://localhost:3001) to check the mock APIs. | ||
This command runs the JSON server, which provides mock APIs. You can access the server at [http://localhost:3001](http://localhost:3001). The JSON server is used for demonstration purposes, and you can check the TODO app after it's up and running. | ||
You can check the TODO app just after up & run this JSON server. | ||
### `npm start` | ||
Runs the app in the development mode.\ | ||
Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
This command runs the app in development mode. You can access the app in your browser at [http://localhost:3000](http://localhost:3000). | ||
The page will reload when you make changes.\ | ||
You may also see any lint errors in the console. | ||
## TODOs | ||
### `npm test` | ||
Here are some tasks that need to be completed or ideas to consider for the project: | ||
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. | ||
1) **Localization:** Implement localization to support multiple languages in the app. | ||
### `npm run build` | ||
2) **Keycloak & Authorization:** Consider implementing Keycloak for authentication and authorization. There might be comments in the code that guide you through the setup. Also, I've another library to simplify this setup, but please note that it might not be up to date. | ||
Builds the app for production to the `build` folder.\ | ||
It correctly bundles React in production mode and optimizes the build for the best performance. | ||
3) **Other Authentication / Authorization Ideas:** Explore additional ideas and best practices related to authentication and authorization, such as using OAuth, JWT, or other security mechanisms. | ||
The build is minified and the filenames include the hashes.\ | ||
Your app is ready to be deployed! | ||
4) **Redux Persist:** Consider implementing Redux Persist to persist the Redux store across sessions, ensuring data retention and improving the user experience. | ||
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. | ||
## 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) | ||
Please feel free to enhance the project based on these tasks and ideas. If you have any specific sections you'd like me to focus on, please let me know, and I'll be happy to further fine-tune the document. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
37
67385