Skip to content

Commit 8db451d

Browse files
gdarkogdarko
authored
Update README.md
1 parent e374dc4 commit 8db451d

File tree

1 file changed

+66
-24
lines changed

1 file changed

+66
-24
lines changed

‎README.md‎

Lines changed: 66 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,42 +33,84 @@ Installation is simple. Just like your ordinary Laravel app.
3333

3434
## ⚡️ How it works
3535

36+
### ➡️ Theming
37+
38+
The project supports theming, you can set a global color for the application theme, it can be done in `tailwind.config.js`.
39+
40+
```js
41+
module.exports = {
42+
// ...
43+
theme: {
44+
extend: {
45+
colors: {
46+
theme: colors.teal,
47+
danger: colors.red
48+
}
49+
}
50+
},
51+
//...
52+
};
53+
```
54+
3655
### ➡️ Authentication
3756

38-
The project ships with complete authentication boilerplate and includes the following pages:
57+
The project ships with complete authentication boilerplate including:
3958
- Login
4059
- Register
4160
- Forget Password
4261
- Reset Password
4362

44-
Also, the project comes with complete `users` crud that can be taken as an example for building other modals.
45-
46-
### ➡️ Structure
47-
48-
The front-end code is located in `resources/js`. The code is organized in different directories to make things more readable.
63+
### ➡️ Users crud
4964

50-
| Directory | Description |
51-
|-----------|---------------------------------------|
52-
| views | The home of the views |
53-
| + pages | The home of the pages |
54-
| + icons | The home of the icons |
55-
| + layouts | The home of the global layouts |
56-
| + utils | The home of the other utilities |
57-
| plugins | The home of the plugins configuration |
58-
| router | The home of the router configuration |
59-
| services | The home of the API services |
60-
| stores | The home of the Pinia stores |
61-
| utils | The home of the utility functions |
65+
For your convenience the project comes with complete `users` crud that includes examples of:
6266

63-
### ➡️ Examples
67+
- List page with filters and pagination
68+
- Edit/create pages with form for editing user that includes ajax based role search field
6469

65-
The project ships with two examples as follows:
70+
### ➡️ Structure
6671

67-
- views/pages/private/dashboard - Shows paginated list of messages with a form for sending a message.
68-
- views/pages/private/users - Shows paginated list of system users along with crud screens.
72+
The front-end code is located in `resources/js`. The code is organized in different directories to make things more readable.
6973

70-
You will probably remove the examples once you start developing your app on top of this project.
71-
<p><img width="100%" src="https://user-images.githubusercontent.com/5760249/210152137-a3241e4e-20d9-4309-9788-e5fe704e084f.webm"/></p>
74+
| Directory | Description |
75+
|--------------|---------------------------------------|
76+
| views | The home of views |
77+
| + pages | The home of the pages |
78+
| + icons | The home of the icons |
79+
| + layouts | The home of the global layouts |
80+
| + components | The home of the reusable components |
81+
| helpers | The home of the helper utilites |
82+
| plugins | The home of the plugins configuration |
83+
| router | The home of the router configuration |
84+
| services | The home of the HTTP services |
85+
| stores | The home of the Pinia stores |
86+
| stub | The home of the static constants |
87+
88+
### ➡️ Components
89+
90+
The project ships with the most useful components that are required for one application (no bullshit), including:
91+
92+
| Name | Description | Parameters | Events | Location |
93+
|-----------|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|------------------------|
94+
| Page | The main page wrapper | title, breadcrumbs (array), actions (array of actions on top), is-loading | n/a | views/layouts |
95+
| Panel | Panel wrapper for displaying panels into the pages | title, is-loading, body-padding | n/a | views/components |
96+
| Modal | Modal wrapper for creating modals | is-showing, is-loading, show-close | @close | views/components |
97+
| Form | Form wrapper | title, is-loading | n/a | views/components |
98+
| Table | A custom table with sorting and pagination support | headers (array), records (array), actions (array of row actions), sorting (object of keys with true/false), pagination: (object of Laravel pagination data) | @page-changed, @action, $sort | views/components |
99+
| Alert | Alert component that pulls alrts from AlertStore | n/a | n/a | views/components |
100+
| Badge | Component that displays highlighted text with background | theme (success, info, warning, danger, error) | n/a | views/components |
101+
| TextInput | Custom text field with type={text,..., textarea} support | name, label, v-model, type (text,...,textarea, etc), show-label, required, disabled, placeholder | default | views/components/input |
102+
| FileInput | File input with custom button and multiple choices support | name, label, v-model, show-label, required, disabled, placeholder, multiple, accept | default + @click, @error, @input, @clear | views/components/input |
103+
| Dropdown | Dropdown field with server side support | name, label, v-model, show-label, required, disabled, placeholder, multiple, server (endpoint), server-per-page (items per page), server-search-min-characters | default | views/components/input |
104+
| Button | Button/Router link component | label, icon, theme (success, info, warning, danger, error), disabled, to (:to is router url, when specified the button is rendered as router-link) | default | views/components/input |
105+
| Spinner | Spinner icon used mostly for loading | text, text-new-line (whether to break the text under the spinner) | n/a | views/components/icons |
106+
| Icon | Icon wrapper, currently uses fork awesome | name (the icon name without the fa- part) | n/a | views/components/icons |
107+
| Avatar | Default Avatar icon | n/a | n/a | views/components/icons |
108+
109+
Note: Please always look in the components, this table does not show everything.
110+
111+
From here, you are on your own. Develop new pages, models, components, use professional IDE for development to improve your efficiency.
112+
113+
<p><img width="100%" src="https://user-images.githubusercontent.com/5760249/210167222-e04312ac-46ef-4dcd-a4d5-00c3a207bf32.gif"/></p>
72114

73115
## ⚡️ Contributions
74116

0 commit comments

Comments
 (0)