update,

nssheung/School-Management-System/README.md

@@ -0,0 +1,95 @@
+# README
+
+## To start develop environment
+
+## Production
+
+TODO: fill production steps here, windows
+
+```bash
+# docker-compose.prod.yml ?
+```
+
+## Development
+
+### Using windows
+
+```bash
+
+# For windows,
+# on project root directory, under windows command prompt
+>.\scripts\up.ps1
+
+# For Linux,
+$ ./scripts/up.sh
+
+# inside docker, run
+/app$ ./dev.sh
+
+# follow setup steps inside docker prompt
+# ...
+# ...
+Do you really wish to run this command? (yes/no) [no]
+# answer -> yes
+# ...
+# ...
+# setup steps complete
+# browse localhost:8000
+```
+
+### Using linux
+
+```shell
+# for linux machine
+
+$ cd src
+
+$ ./up.sh
+
+# inside docker
+
+# options :
+
+# 1. to start laravel only:
+$ ./dev.sh
+
+# 2. to start refreshing when src update:
+$ npm run dev
+
+# brows:
+# page http://localhost:3000
+# mail test node http://localhost:8025
+```
+
+## pack for delivery
+
+```bash
+# under project root directory, run
+>./pack_delivery.bat
+
+# delivery file available on <PROJ_ROOT>\dist\delivery.zip
+```
+
+## report materials
+
+- password reset email template:
+
+  - https://laravel.com/docs/10.x/passwords
+  - `php artisan make:notification ResetPasswordNotification`
+  - `php artisan vendor:publish --tag=laravel-notifications`
+
+- mailhog
+- https://github.com/barryvdh/laravel-dompdf
+
+  - https://www.positronx.io/laravel-pdf-tutorial-generate-pdf-with-dompdf-in-laravel/
+
+- https://github.com/sparksuite/simple-html-invoice-template
+
+## still useful ?
+
+/home/logic/\_workspace/laravel-playlist/laravel-docker-helloworld/blog-stripe-tryout/php74-httpd/blog-stripe/resources/views/pages/home/index.blade.php
+
+### references :
+
+https://github.com/AngelJayMedia/blog-stripe
+https://laravel.com/docs/10.x/controllers#basic-controllers