Skip to content

Commit dcb2d5a

Browse files
committed
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.
1 parent bf75db3 commit dcb2d5a

File tree

8 files changed

+76
-66
lines changed

8 files changed

+76
-66
lines changed

CODE_OF_CONDUCT.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
- Using welcoming and inclusive language
18-
- Being respectful of differing viewpoints and experiences
19-
- Gracefully accepting constructive criticism
20-
- Focusing on what is best for the community
21-
- Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
- The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
- Trolling, insulting/derogatory comments, and personal or political attacks
28-
- Public or private harassment
29-
- Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
- Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
3333

3434
## Our Responsibilities
3535

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,26 @@ whether or not your feature is likely to be used by other users of the project.
3030

3131
Before filing an issue:
3232

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.
3737

3838
Before submitting a pull request:
3939

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.
4242

4343
## Requirements
4444

4545
If the project maintainer has any additional requirements, you will find them listed here.
4646

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`.
4848

49-
- **Add tests!** - Please **allways** provide tests .
49+
- **Add tests!** - Please **allways** provide tests .
5050

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.
5252

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.
5454

5555
Happy coding, and thanks for being part of our community! 🎉

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@
1717

1818
Starting a new web application usually means tackling a bunch of common yet crucial tasks, including:
1919

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.
3131

3232
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.
3333

@@ -43,35 +43,35 @@ The VILT Stack is a powerful combination of frameworks and tools that provide a
4343

4444
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:
4545

46-
- [Vue 3](https://vuejs.org/) (Drives custom frontend components)
47-
- [Inertia.js](https://inertiajs.com/) (Bridges the gap between frontend and backend)
48-
- [Laravel 12](https://laravel.com/) (Empowers the backend)
49-
- [Tailwind CSS 4](https://tailwindcss.com/) (Styles with ease)
50-
- [Vite](https://vitejs.dev/) (Accelerates frontend tooling)
46+
- [Vue 3](https://vuejs.org/) (Drives custom frontend components)
47+
- [Inertia.js](https://inertiajs.com/) (Bridges the gap between frontend and backend)
48+
- [Laravel 12](https://laravel.com/) (Empowers the backend)
49+
- [Tailwind CSS 4](https://tailwindcss.com/) (Styles with ease)
50+
- [Vite](https://vitejs.dev/) (Accelerates frontend tooling)
5151

5252
When you bring Modular into your Laravel application, here’s a taste of what you'll unlock:
5353

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 ;)
6363

6464
## Custom Vue 3 Components
6565

6666
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:
6767

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.
7575

7676
At present, Modular furnishes the following Custom Vue 3 Components:
7777

stubs/resources/js/Components/DataTable/AppDataSearch.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const props = defineProps({
4040
type: Object,
4141
default: () => {}
4242
},
43-
placeholder: {
43+
placeholder: {
4444
type: String,
4545
default: 'Search'
4646
}

stubs/resources/js/Components/Form/AppMultiCombobox.vue

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div ref="wrapperRef" class="relative w-64">
33
<!-- Button to open dropdown -->
44
<AppButton
5-
class="mt-1 flex w-full flex-wrap justify-between rounded-md border-0 bg-skin-neutral-1 px-3 py-2 text-left text-skin-neutral-12 shadow-sm ring-1 ring-inset ring-skin-neutral-7 focus:ring-2 focus:ring-inset focus:ring-skin-neutral-7 sm:text-sm sm:leading-6"
5+
class="bg-skin-neutral-1 text-skin-neutral-12 ring-skin-neutral-7 focus:ring-skin-neutral-7 mt-1 flex w-full flex-wrap justify-between rounded-md border-0 px-3 py-2 text-left shadow-sm ring-1 ring-inset focus:ring-2 focus:ring-inset sm:text-sm sm:leading-6"
66
aria-haspopup="true"
77
:aria-expanded="isOpen"
88
@click="toggleState"
@@ -12,7 +12,7 @@
1212
<span
1313
v-for="(item, index) in modelValue"
1414
:key="item.value"
15-
class="flex items-center rounded bg-skin-neutral-3 px-2 py-1 text-xs text-skin-neutral-12"
15+
class="bg-skin-neutral-3 text-skin-neutral-12 flex items-center rounded px-2 py-1 text-xs"
1616
>
1717
{{ item.label }}
1818
<i
@@ -68,7 +68,7 @@
6868
v-for="(option, index) in filteredOptions"
6969
:key="option.value"
7070
role="option"
71-
class="flex items-center gap-2 px-4 py-2 text-sm hover:cursor-pointer hover:bg-skin-neutral-3 hover:text-skin-neutral-12"
71+
class="hover:bg-skin-neutral-3 hover:text-skin-neutral-12 flex items-center gap-2 px-4 py-2 text-sm hover:cursor-pointer"
7272
:class="{
7373
'bg-skin-neutral-3 text-skin-neutral-12':
7474
index === highlightedIndex
@@ -97,7 +97,6 @@ import useClickOutside from '@resources/js/Composables/useClickOutside'
9797
const props = defineProps({
9898
modelValue: {
9999
type: Array,
100-
required: true,
101100
default: () => []
102101
},
103102
comboLabel: {
@@ -212,9 +211,12 @@ const remove = (index) => {
212211
</script>
213212

214213
<style scoped>
214+
@reference "../../../css/app.css";
215+
215216
.slide-fade-enter-active,
216217
.slide-fade-leave-active {
217-
@apply transition-all duration-200 ease-in;
218+
@apply transition-all duration-200;
219+
transition-timing-function: ease-in;
218220
}
219221
.slide-fade-enter-from,
220222
.slide-fade-leave-to {

stubs/resources/js/Components/Form/AppTipTapEditor.vue

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,12 @@ import { useEditor, EditorContent } from '@tiptap/vue-3'
295295
import StarterKit from '@tiptap/starter-kit'
296296
import Image from '@tiptap/extension-image'
297297
import Youtube from '@tiptap/extension-youtube'
298-
import { Table, TableCell, TableHeader, TableRow } from '@tiptap/extension-table'
298+
import {
299+
Table,
300+
TableCell,
301+
TableHeader,
302+
TableRow
303+
} from '@tiptap/extension-table'
299304
import TipTapButton from './TipTap/TipTapButton.vue'
300305
import TipTapDivider from './TipTap/TipTapDivider.vue'
301306

stubs/resources/js/Components/Misc/AppTopBar.vue

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,14 @@
2222
<i
2323
:class="iconFullscreenClass"
2424
class="transition-transform duration-500 ease-in-out"
25-
:style="{ transform: isFullscreen ? 'rotate(180deg) scale(1.2)' : 'rotate(0deg) scale(1)' }"
25+
:style="{
26+
transform: isFullscreen
27+
? 'rotate(180deg) scale(1.2)'
28+
: 'rotate(0deg) scale(1)'
29+
}"
2630
></i>
2731
</AppButton>
2832

29-
3033
<!-- Theme toggle -->
3134
<AppButton
3235
href="#"
@@ -36,7 +39,6 @@
3639
<i :class="iconThemeClass"></i>
3740
</AppButton>
3841

39-
4042
<!-- Logout -->
4143
<AppButton
4244
class="btn btn-icon hover:bg-skin-neutral-5"
@@ -51,7 +53,7 @@
5153
<script setup>
5254
import { ref, onMounted, onUnmounted } from 'vue'
5355
54-
const props = defineProps({
56+
defineProps({
5557
title: {
5658
type: String,
5759
default: ''

stubs/resources/js/Resolvers/AppComponentsResolver.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const componentGroups = {
1818
'AppInputPassword',
1919
'AppInputText',
2020
'AppLabel',
21+
'AppMultiCombobox',
2122
'AppRadioButton',
2223
'AppTextArea',
2324
'AppTipTapEditor'

0 commit comments

Comments
 (0)