You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Refactor documentation and improve code formatting
- Updated CODE_OF_CONDUCT.md and CONTRIBUTING.md for consistency in formatting.
- Enhanced README.md for clarity and readability.
- Made minor adjustments to Vue component files for improved code style and organization.
- Added AppMultiCombobox to AppComponentsResolver.js for better component management.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,26 +30,26 @@ whether or not your feature is likely to be used by other users of the project.
30
30
31
31
Before filing an issue:
32
32
33
-
-Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
34
-
-Check to make sure your feature suggestion isn't already present within the project.
35
-
-Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
36
-
-Check the pull requests tab to ensure that the feature isn't already in progress.
33
+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
34
+
- Check to make sure your feature suggestion isn't already present within the project.
35
+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
36
+
- Check the pull requests tab to ensure that the feature isn't already in progress.
37
37
38
38
Before submitting a pull request:
39
39
40
-
-Check the codebase to ensure that your feature doesn't already exist.
41
-
-Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
40
+
- Check the codebase to ensure that your feature doesn't already exist.
41
+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
42
42
43
43
## Requirements
44
44
45
45
If the project maintainer has any additional requirements, you will find them listed here.
46
46
47
-
-**Coding Standard** - To format the PHP code run `./vendor/bin/pint`. To lint the JavaScript code and Vue SFC, run `npm run lint`, and to format `npm run format`.
47
+
-**Coding Standard** - To format the PHP code run `./vendor/bin/pint`. To lint the JavaScript code and Vue SFC, run `npm run lint`, and to format `npm run format`.
48
48
49
-
-**Add tests!** - Please **allways** provide tests .
49
+
-**Add tests!** - Please **allways** provide tests .
50
50
51
-
-**One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
51
+
-**One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52
52
53
-
-**Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
53
+
-**Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54
54
55
55
Happy coding, and thanks for being part of our community! 🎉
Copy file name to clipboardExpand all lines: README.md
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,17 +17,17 @@
17
17
18
18
Starting a new web application usually means tackling a bunch of common yet crucial tasks, including:
19
19
20
-
-**Scalable Architecture:** Structuring your application in a way that scales seamlessly with growth.
21
-
-**Robust Access Control:** Crafting a granular ACL (Access Control List) to manage users and roles proficiently.
22
-
-**Intuitive Admin Panel:** Either customizing a ready-made or developing a bespoke Admin Panel to streamline your application's construction.
23
-
-**Responsive Design:** Ensuring your Admin Panel is mobile-friendly and responsive across devices.
24
-
-**Unified UI Toolkit:** Adopting or developing a UI Toolkit to fast-track frontend development while maintaining a coherent design across pages.
25
-
-**Effortless Frontend-Backend Integration:** Bridging your frontend and backend intuitively, ensuring a maintainable and straightforward connection.
26
-
-**Optimized Build Management:** Harnessing the right toolset and stack to manage your frontend application's build steps efficiently.
27
-
-**Reusable Components:** Abstracting common functionalities and components for reuse (embrace DRY - Don't Repeat Yourself), such as data search, pagination, flash messages, and more.
28
-
-**Thorough Testing Frameworks:** Implementing testing frameworks to validate your application's functionality.
29
-
-**Comprehensive Activity Log:** Keeping a detailed log to audit user operations.
30
-
-**Clear Architectural Vision:** Maintaining a lucid mental model of the project's architectural decisions, promoting consistency and a solid understanding of how all elements interlink.
20
+
-**Scalable Architecture:** Structuring your application in a way that scales seamlessly with growth.
21
+
-**Robust Access Control:** Crafting a granular ACL (Access Control List) to manage users and roles proficiently.
22
+
-**Intuitive Admin Panel:** Either customizing a ready-made or developing a bespoke Admin Panel to streamline your application's construction.
23
+
-**Responsive Design:** Ensuring your Admin Panel is mobile-friendly and responsive across devices.
24
+
-**Unified UI Toolkit:** Adopting or developing a UI Toolkit to fast-track frontend development while maintaining a coherent design across pages.
25
+
-**Effortless Frontend-Backend Integration:** Bridging your frontend and backend intuitively, ensuring a maintainable and straightforward connection.
26
+
-**Optimized Build Management:** Harnessing the right toolset and stack to manage your frontend application's build steps efficiently.
27
+
-**Reusable Components:** Abstracting common functionalities and components for reuse (embrace DRY - Don't Repeat Yourself), such as data search, pagination, flash messages, and more.
28
+
-**Thorough Testing Frameworks:** Implementing testing frameworks to validate your application's functionality.
29
+
-**Comprehensive Activity Log:** Keeping a detailed log to audit user operations.
30
+
-**Clear Architectural Vision:** Maintaining a lucid mental model of the project's architectural decisions, promoting consistency and a solid understanding of how all elements interlink.
31
31
32
32
The intricacies of these tasks are far from trivial, often demanding a substantial amount of time and attention. As you delve deeper, you may encounter additional minor behaviors and tweaks that, while seemingly marginal, are crucial and time-consuming.
33
33
@@ -43,35 +43,35 @@ The VILT Stack is a powerful combination of frameworks and tools that provide a
43
43
44
44
Modular stands on the shoulders of giants, integrating powerful frameworks and tools to offer a streamlined development experience. Here’s what lies under the hood:
When you bring Modular into your Laravel application, here’s a taste of what you'll unlock:
53
53
54
-
-A **Themed Admin Panel** seamlessly integrated with Tailwind CSS, ready to assist you in crafting your application.
55
-
-A finely-tuned **ACL (Access Control List) System** to effortlessly manage users and roles.
56
-
-A suite of auto-loaded **Custom Vue 3 Components**, penned in **JavaScript**, and tailored with Tailwind CSS; ready for use.
57
-
-Vite for a **lightning-fast frontend development** journey.
58
-
-Inertia.js to ensure a smooth frontend and backend connection, **simplifying routing and component data hydration**, among other benefits.
59
-
-A **custom-built CLI** to swiftly generate new modules; propelling your **development speed**.
60
-
-A comprehensive **translation system** ready to help your application speak the world's languages (if needed).
61
-
-**Build steps** for your frontend application are set, pre-configured, and ready to roll from the get-go, with the right tooling and stack to keep the momentum high.
62
-
-A **developer experience** designed to leave a grin on your face at the end of each coding day ;)
54
+
- A **Themed Admin Panel** seamlessly integrated with Tailwind CSS, ready to assist you in crafting your application.
55
+
- A finely-tuned **ACL (Access Control List) System** to effortlessly manage users and roles.
56
+
- A suite of auto-loaded **Custom Vue 3 Components**, penned in **JavaScript**, and tailored with Tailwind CSS; ready for use.
57
+
- Vite for a **lightning-fast frontend development** journey.
58
+
- Inertia.js to ensure a smooth frontend and backend connection, **simplifying routing and component data hydration**, among other benefits.
59
+
- A **custom-built CLI** to swiftly generate new modules; propelling your **development speed**.
60
+
- A comprehensive **translation system** ready to help your application speak the world's languages (if needed).
61
+
-**Build steps** for your frontend application are set, pre-configured, and ready to roll from the get-go, with the right tooling and stack to keep the momentum high.
62
+
- A **developer experience** designed to leave a grin on your face at the end of each coding day ;)
63
63
64
64
## Custom Vue 3 Components
65
65
66
66
In previous iterations of Modular, I leveraged robust UI Toolkits like Vuetify and Prime Vue. While these are excellent options, a desire for more control over the components led to a change, guided by the following criteria:
67
67
68
-
-Adoption of Vue 3 as the primary JavaScript framework.
69
-
-Employment of Tailwind CSS for styling purposes.
70
-
-Seamless integration of Custom Vue 3 Components with the Tailwind Theme System.
71
-
-Easy customization of components by merely editing them. To facilitate this, components reside not in node_modules, but in "./resources/js/Components". Need some tweaking? Open the component, modify the Tailwind CSS classes, and save it. Done.
72
-
-No use of Sass, Less, Stylus, etc. Tailwind CSS exclusively.
73
-
-No TypeScript. Pure JavaScript only.
74
-
-Light and exceedingly straightforward Common Components. If necessary, extend or create new components per project to imbue additional functionality.
68
+
- Adoption of Vue 3 as the primary JavaScript framework.
69
+
- Employment of Tailwind CSS for styling purposes.
70
+
- Seamless integration of Custom Vue 3 Components with the Tailwind Theme System.
71
+
- Easy customization of components by merely editing them. To facilitate this, components reside not in node_modules, but in "./resources/js/Components". Need some tweaking? Open the component, modify the Tailwind CSS classes, and save it. Done.
72
+
- No use of Sass, Less, Stylus, etc. Tailwind CSS exclusively.
73
+
- No TypeScript. Pure JavaScript only.
74
+
- Light and exceedingly straightforward Common Components. If necessary, extend or create new components per project to imbue additional functionality.
75
75
76
76
At present, Modular furnishes the following Custom Vue 3 Components:
0 commit comments