From 3f0ef9b9b8d7ba7c28586b74e23aa235a15f5db6 Mon Sep 17 00:00:00 2001 From: Zakaria Labib <58374576+Zakarialabib@users.noreply.github.com> Date: Sun, 17 Dec 2023 22:10:43 +0100 Subject: [PATCH] Update README.md --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 66 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dfae54b..c2f601d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ -# corporateWeb - +## Overview + +CorporateWeb, a Laravel and livewire CMS, for content creator or businesses. Offering a user-friendly dashboard, and an array of features, it becomes your partner in efficient business management and growth. + +Features: + + +Built with Laravel 10, Livewire 3, and Tailwind CSS, ensuring a super fast experiance, without bundling assest. + + + +## Login with the following credentials + - Email: `admin@mail.com` + - Password: `password` + +## Requirements + +- PHP >= 8.2 (or higher) +- Composer +- Node.js +- NPM +- MySQL + +## Installation + +1. Clone the repository +2. Run `composer install` +3. Run `npm install` +4. Run `npm run dev` +5. Create a database and update the `.env` file +6. Run `php artisan migrate --seed` +7. run `php artisan key:generate` +8. Run `php artisan serve` +9. Login with the following credentials + - Email: `admin@ggmail.com` + - Password: `password` +10. Enjoy! + +## License + +The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). + +## Credits + +- [Laravel](https://laravel.com/) +- [Tailwind CSS](https://tailwindcss.com/) +- [Livewire 3](https://laravel-livewire.com/) + +## Screenshots : + + +## Contact + +- [Twitter](https://twitter.com/zakarialabib) +- [LinkedIn](https://www.linkedin.com/in/zakaria-labib/) +- [GitHub](https://www.github.com/zakarialabib/) + +## Donate + +If you like this project, leave a star and share it with your friends. + +## Contributors + +| Contributor | GitHub Profile | +| --- | --- | +| [Zakarialabib](https://github.com/Zakarialabib) | [![Avatar](https://github.com/Zakarialabib.png?size=50)](https://github.com/Zakarialabib) |