From 41243e62a0386c3ebe3fa47145c33662af3d9d0a Mon Sep 17 00:00:00 2001
From: litsynp <nocte55is@gmail.com>
Date: Sat, 20 Apr 2024 14:05:45 +0900
Subject: [PATCH] chore: update docs and makefile

---
 Makefile     | 16 +++++++++-------
 README.md    | 28 +++++++++++++++++++++++++++-
 package.json |  3 ++-
 3 files changed, 38 insertions(+), 9 deletions(-)

diff --git a/Makefile b/Makefile
index d8949dd..b1a6878 100644
--- a/Makefile
+++ b/Makefile
@@ -7,18 +7,20 @@ watch:
 watch\:uninstall:
 	cargo uninstall cargo-watch
 
-db-up:
-	make db-down
+db\:up:
+	make db\:down
 	docker-compose up -d --remove-orphans
-db-down:
+db\:down:
 	docker-compose down
+db\:destroy:
+	docker-compose down -v
 
-migration-install:
+migration\:install:
 	cargo install sqlx-cli
-migration-up:
+migration\:up:
 	sqlx migrate run
 
-docs-open-swagger:
+docs\:open\:swagger:
 	open http://localhost:$(PORT)/swagger-ui
-docs-open-rapidoc:
+docs\:open\:rapidoc:
 	open http://localhost:$(PORT)/rapidoc
diff --git a/README.md b/README.md
index 8b6beab..648607d 100644
--- a/README.md
+++ b/README.md
@@ -21,13 +21,14 @@ A Rust example of a todo application with axum and sqlx.
 - dotenv
 - chrono
 - utoipa
+- askama (for frontend with tailwindcss)
 
 ## Run the Application
 
 ### Docker
 
 ```sh
-$ docker-compose up -d
+$ make db:up  # make db:down to stop and db:destroy to remove
 ```
 
 ### Database Setup
@@ -43,6 +44,13 @@ $ sqlx migrate run # run migrations
 $ cargo run
 ```
 
+If you want to watch for file changes, you can use `cargo watch`:
+
+```sh
+$ make watch:install  # Install cargo-watch
+$ make watch
+```
+
 ### Run (Production)
 
 ```sh
@@ -71,3 +79,21 @@ This project includes a CLI to add users to the database.
 $ cargo run --bin add-user -- --email=user@example.com --nickname=user --password=1234
 Successfully registered user User { id: 1, email: "user@example.com", password: "1234", nickname: "user", created_at: 2024-04-19T17:14:54.358424Z, updated_at: 2024-04-19T17:14:54.358424Z, deleted_at: None }
 ```
+
+## Frontend
+
+![image](https://private-user-images.githubusercontent.com/42485462/324154929-951b9588-7999-4234-b2ab-9644e9f31600.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTM1ODk0MDUsIm5iZiI6MTcxMzU4OTEwNSwicGF0aCI6Ii80MjQ4NTQ2Mi8zMjQxNTQ5MjktOTUxYjk1ODgtNzk5OS00MjM0LWIyYWItOTY0NGU5ZjMxNjAwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA0MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNDIwVDA0NTgyNVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTgzMmIxMjYxZThlZGE4OGIyYTU1NjE3Y2Q2ZmY1MTUzYWIxNmIwNGVmNGJkZmFhN2YwMzdmMjk3Y2M2MjA3NzgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.F40j2WDIzQiFheaTgm9Dt8fk7IBcIGjqT7aq-dDPPJg)
+
+This project uses askama to render HTML templates.
+
+If you need to access the frontend, you can run the following command:
+
+```sh
+$ npm install
+$ npm run tailwind:build # or npm run tailwind:watch to watch for changes
+```
+
+Go to index page at [`/`](http://localhost:8000/) and login
+at [`/login`](http://localhost:8000/login).
+
+You can add, edit and delete todos.
diff --git a/package.json b/package.json
index a4432d5..05ab55f 100644
--- a/package.json
+++ b/package.json
@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "format": "prettier --write --ignore-unknown .",
-    "watch:tailwind": "npx tailwindcss -i styles/tailwind.css -o assets/main.css --watch"
+    "tailwind:build": "npx tailwindcss -i styles/tailwind.css -o assets/main.css",
+    "tailwind:watch": "npx tailwindcss -i styles/tailwind.css -o assets/main.css --watch"
   },
   "repository": {
     "type": "git",