Revise README.md to enhance clarity and detail about the Modular Demo App, including installation instructions, features, and links to demo applications.

Author: daniel-cintra

README.md

@@ -1,66 +1,135 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+# Modular Demo App
 
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
+A demo application to illustrate some concepts of a Modular App.
+
+<p align="center" style="margin: 24px;">
+    <a href="https://docs.ismodular.com" target="_blank">
+    <img src="art/modular-demo-screen-black.jpg" alt="Modular Demo App" style="width: 100%; max-width: 800px;"></a>
 </p>
 
-## About Laravel
+<center>
+
+[![Vue v3.x](https://img.shields.io/badge/Vue.js-v3.x-2f4053?style=for-the-badge&logo=vue.js&logoColor=39af78)](https://vuejs.org/)
+[![Inertia.js v2.x](https://img.shields.io/badge/Inertia.js-v2.x-6765ea?style=for-the-badge&logo=inertia&logoColor=ffffff)](https://inertiajs.com/)
+[![Laravel v12.x](https://img.shields.io/badge/Laravel-v12.x-FF2D20?style=for-the-badge&logo=laravel)](https://laravel.com)
+[![Tailwind CSS v4.x](https://img.shields.io/badge/Tailwind%20CSS-v4.x-31b5f7?style=for-the-badge&logo=tailwind-css&logoColor=ffffff)](https://tailwindcss.com/)
+[![Tests passing](https://img.shields.io/badge/Tests-passing-green?style=for-the-badge&logo=github)](https://github.com/daniel-cintra/modular/actions)
+
+</center>
+
+## The Demo App will provide you with examples of:
+
+- The ACL (Access Control List) System.
+- Some of the Custom Vue 3 Components, provided by Modular (Templates, Sidebar, Data Table, Form Components, Integrated Text Editor, Flash Messages, etc).
+- How Laravel, Vue and Inertia.js communicate with each other.
+- A possible way to organize the file structure of a Modular Project.
+- Smooth transitions between pages.
+- The GitHub repository for this demo app includes examples of workflows (GitHub Actions) to standardize the styles of the PHP files using Laravel Pint, and the Vue and JavaScript files using Prettier. There is also a workflow to handle tests. Feel free to check it out!
+
+## Visit the Demo App
+
+You can visit the Modular Panel Demo App (CMS) at [https://demo.ismodular.com](https://demo.ismodular.com).
+
+And the Blog Demo PreviewApp at [https://demo.ismodular.com/blog](https://demo.ismodular.com/blog).
+
+## Installation
+
+Clone the repo locally:
+
+```sh
+git clone https://github.com/daniel-cintra/modular-demo.git modular-demo && cd modular-demo
+```
+
+Install PHP dependencies:
+
+```sh
+composer install
+```
+
+Setup configuration:
+
+```sh
+cp .env.example .env
+```
+
+Generate application key:
+
+```sh
+php artisan key:generate
+```
+
+Configure the database settings in your .env file according to your choice of database (MySQL, PostgreSQL, SQLite, etc.). If you want to use SQLite, create the database file:
+
+```sh
+touch database/database.sqlite
+```
+
+Run database migrations and seeder:
+
+```sh
+php artisan migrate:fresh --seed
+```
+
+Create a symlink to the storage:
+
+```sh
+php artisan storage:link
+```
+
+Copy the blog example images from `resources/images/blog` to `storage/app/public/blog`:
+
+```
+cp -r resources/images/blog storage/app/public/blog
+```
+
+Install NPM dependencies:
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+```sh
+npm install
+```
 
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+Build the assets:
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+```sh
+npm run build
+```
 
-## Learning Laravel
+Run the dev server (the output will give the address):
 
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+```sh
+php artisan serve
+```
 
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+You're ready to go! Simply visit the URL in your browser; the login form will appear with the fields automatically filled in.
 
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+## Hot Reloading
 
-## Laravel Sponsors
+If you want to use hot reloading, to see the changes in the browser without having to refresh the page, run the following command (instead of `npm run build`):
 
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+```sh
+npm run dev
+```
 
-### Premium Partners
+And run the following command in a separate terminal window:
 
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[WebReinvent](https://webreinvent.com/)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
-- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
-- **[Jump24](https://jump24.co.uk)**
-- **[Redberry](https://redberry.international/laravel/)**
-- **[Active Logic](https://activelogic.com)**
-- **[byte5](https://byte5.de)**
-- **[OP.GG](https://op.gg)**
+```sh
+php artisan serve
+```
 
-## Contributing
+Access the application (in your browser) at the address given by the `php artisan serve` command.
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+## Tests
 
-## Code of Conduct
+The tests provided by this Demo Application can be found in the `{moduleName}/Tests` directory. After installing the application, you can run the tests executing the following command from the project root directory in the terminal:
 
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+```sh
+php artisan test
+```
 
-## Security Vulnerabilities
+## Modular Documentation
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+You can find the full Modular documentation at [https://docs.ismodular.com](https://docs.ismodular.com).
 
 ## License
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+The Modular Project is open-source software licensed under the [MIT license](LICENSE.md).