egora-library 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -0
- package/dist/index.cjs.js +130 -0
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.esm.js +130 -0
- package/dist/index.esm.js.map +1 -0
- package/package.json +48 -0
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Egora Library
|
|
2
|
+
|
|
3
|
+
A custom React component library built with Material-UI (MUI) designed for seamless integration with Franchise Theme Editor, Preview, and Live Store environments. Compatible with both React and Next.js projects.
|
|
4
|
+
|
|
5
|
+
- Franchise Theme Editor and Preview
|
|
6
|
+
- Live Store
|
|
7
|
+
|
|
8
|
+
The library is compatible with both **React** and **Next.js** projects.
|
|
9
|
+
|
|
10
|
+
# Installation
|
|
11
|
+
|
|
12
|
+
# Production Version
|
|
13
|
+
|
|
14
|
+
`npm install egora-library`
|
|
15
|
+
|
|
16
|
+
# Environment-Specific Versions
|
|
17
|
+
|
|
18
|
+
# For development
|
|
19
|
+
`npm install egora-library-dev`
|
|
20
|
+
|
|
21
|
+
# For testing
|
|
22
|
+
`npm install egora-library-test`
|
|
23
|
+
|
|
24
|
+
# For staging
|
|
25
|
+
`npm install egora-library-staging`
|
|
26
|
+
|
|
27
|
+
# Requirements
|
|
28
|
+
|
|
29
|
+
- React 16.8+
|
|
30
|
+
- Material-UI (MUI) 5.x
|
|
31
|
+
- Node.js 14+
|
|
32
|
+
|
|
33
|
+
# To Reflect the changes in Dist File
|
|
34
|
+
|
|
35
|
+
1. Remove dist folder node modules and package.lock.json file
|
|
36
|
+
`rm -rf dist node_modules package-lock.json`
|
|
37
|
+
|
|
38
|
+
2. Install the dependencies again
|
|
39
|
+
`npm i --force`
|
|
40
|
+
|
|
41
|
+
3. Create the build
|
|
42
|
+
`npm run build`
|
|
43
|
+
|
|
44
|
+
# Troubleshooting
|
|
45
|
+
|
|
46
|
+
- If encountering issues after installation:
|
|
47
|
+
- Clear your project's node_modules and package-lock.json
|
|
48
|
+
- Reinstall dependencies
|
|
49
|
+
- Restart your development server
|
|
50
|
+
|
|
51
|
+
# Environment Setup
|
|
52
|
+
|
|
53
|
+
- Set the environment variable in a .env file:
|
|
54
|
+
|
|
55
|
+
# For React
|
|
56
|
+
- REACT_APP_ENV='development' # development
|
|
57
|
+
- REACT_APP_ENV='test' # test
|
|
58
|
+
- REACT_APP_ENV='staging' # staging
|
|
59
|
+
- REACT_APP_ENV='production' # production
|
|
60
|
+
|
|
61
|
+
# For Next.js
|
|
62
|
+
- NEXT_PUBLIC_ENV='development' # development
|
|
63
|
+
- NEXT_PUBLIC_ENV='test' # test
|
|
64
|
+
- NEXT_PUBLIC_ENV='staging' # staging
|
|
65
|
+
- NEXT_PUBLIC_ENV='production' # production
|
|
66
|
+
|
|
67
|
+
# Notes
|
|
68
|
+
|
|
69
|
+
- Automatically loads the correct package based on environment.
|
|
70
|
+
- No manual setup.(Egora project detects environment and installs automatically).
|
|
71
|
+
- Always rebuild the library after making changes to reflect updates in the `dist` folder.
|
|
72
|
+
- Dynamic imports enable seamless environment switching.
|
|
73
|
+
|
|
74
|
+
# Team
|
|
75
|
+
|
|
76
|
+
- Mahum Maqbool - https://github.com/mahum24
|
|
77
|
+
- Muhammad Sufyan - https://github.com/msufyan634
|
|
78
|
+
- Musfirah Saleem - https://github.com/musfirah-saleem
|
|
79
|
+
- Zain ul Abideen - https://github.com/ZA535
|