dynamic-personalization-ui
v0.1.9
Published
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Downloads
12
Readme
Getting Started with Create React App
This project was bootstrapped with Create React App.
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 the browser.
The page will reload if you make edits.
You will 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.
App Customization
The project have a set of variables that manage the colors, fonts and some general styles that can be esily modified to change the look of the application. Those variables are located in the next path: src/base/variables.
Variables
- Colors
- fonts
- Breakpoints
- Spacing
Colors
The color variables consist of an object with 8 keys that define the primary, secondary, error, warning and more colors of the application. Those colors are converted (lightened, darkened) later in the theme setup into colors that complete the MUI theme requierements.
fonts
The font variables define all the font styles needed including, font families, font values breakpoint, global font size and all the values attached to the heading and paragraph tags.
Breakpoints
This consist of an object that define the brekpoints of the application. For example This can be used using mui theme as "@media (min-width: ${theme.breakpoints.values.md}px)" and this will create a media query for 900 px and above.
Spacing
This variable have an array that have numbers, each number is a measurament in pixels to be used as margins or paddings. For example This can be used using mui theme as margin: theme.spacing(2) and it will return 8px of margin.
Theme
For theming the project use [MUI theme](https://mui.com/material-ui/customization/theming. All the variables previously defined were processed to be values that match the requierements Mui have on his theme.