Update README.md

README.md

@@ -1,17 +1,85 @@
-Complaint Management System (Got Your Back)
-
-How to get started
-
-1. Clone This repository
-2. run composer update
-3. copy .env.example file to .env
-4. edit your database configurations
-6. generate application key by running php artisan key:generate command
-7. Run migration
-8. Run database seed
-9. Start your application
-10. You can access your application at localhost:8000, admin can login through localhost:8000/login
-
-Demo logins
-username: admin@admin.com
-Password: 123456
+
+# Laravel+Vue Complaint system
+
+
+[![Build Status](https://dev.azure.com/anowarhossain/laravel-vue-crud-starter/_apis/build/status/AnowarCST.laravel-vue-crud-starter?branchName=master)](https://dev.azure.com/anowarhossain/laravel-vue-crud-starter/_build/latest?definitionId=6&branchName=master)
+
+
+## About Repository
+
+A very simple Laravel 8 + Vue 2 + AdminLTE 3 based complaint management system.
+
+## Tech Specification
+
+- Laravel 8
+- Vue 2 + VueRouter + vue-progressbar + sweetalert2 + laravel-vue-pagination
+- Laravel Passport
+- Admin LTE 3 + Bootstrap 4 + Font Awesome 5
+- PHPUnit Test Case/Test Coverage
+
+## Features
+
+- Modal based Create+Edit, List with Pagination, Delete with Sweetalert
+- Login, Register, Forget+Reset Password as default auth
+- Profile, Update Profile, Change Password, Avatar
+- Complaints management
+- User Management
+- Settings: Categories, sites
+- Frontend and Backend User ACL with Gate Policy (type: admin/user)
+- Simple Dynamic Dashboard
+- Developer Options for OAuth Clients and Personal Access Token
+- Build with Docker
+
+## Installation
+
+- `git clone https://github.com/ngoijr3107/complaint-system.git`
+- `cd complaint-system/`
+- `composer install`
+- `cp .env.example .env`
+- Update `.env` and set your database credentials
+- `php artisan key:generate`
+- `php artisan migrate`
+- `php artisan db:seed`
+- `php artisan passport:install`
+- `npm install`
+- `npm run dev`
+- `php artisan serve`
+
+## Install with Docker
+
+- `docker-compose up -d`
+- `docker exec -it complaint-system /bin/bash`
+- `composer install`
+- `cp .env.example .env`
+- `php artisan key:generate`
+- `php artisan migrate`
+- `php artisan db:seed`
+- `php artisan passport:install`
+- Application http://localhost:8008/
+- Adminer for Database http://localhost:8080/
+- DBhost: yourIP:3307, user: root, Password: 123456
+
+
+## Unit Test
+
+#### run PHPUnit
+
+```bash
+# run PHPUnit all test cases
+vendor/bin/phpunit
+# or Feature test only
+vendor/bin/phpunit --testsuite Feature
+```
+
+#### Code Coverage Report
+
+```bash
+# reports is a directory name
+vendor/bin/phpunit --coverage-html reports/
+```
+A `reports` directory has been created for code coverage report. Open the dashboard.html.
+
+
+## License
+
+[MIT license](https://opensource.org/licenses/MIT).