Merge pull request #3 from XinitTeam/master

Readme: Added readme-en.md english translation

Author: hhstore

.gitignore

@@ -41,3 +41,5 @@ tmp/
 
 # goreleaser artifacts
 dist/
+translate_all_readme.sh
+format_lines.py

mono-repo/gin/{{cookiecutter.repo_name}}/app/basic/user/identity/readme-en.md

@@ -0,0 +1,6 @@
+English | [简体中文](readme.md)
+
+# user:
+
+- Account system, support various third-party login methods
+

mono-repo/gin/{{cookiecutter.repo_name}}/app/basic/user/readme-en.md

@@ -0,0 +1,13 @@
+English | [简体中文](readme.md)
+
+# user:
+
+- union
+- User Center:
+    - Account system
+    - Login authentication
+    - User roles
+    - User rights
+
+
+

mono-repo/gin/{{cookiecutter.repo_name}}/app/std/readme-en.md

@@ -0,0 +1,33 @@
+English | [简体中文](readme.md)
+# std:
+
+- Standard definition of the project itself:
+
+- public error code
+- Common configuration file definition format
+- Public interface parameter convention specification
+
+
+
+```bash
+
+err code:
+
+config fmt:
+
+req/resp arg fmt:
+
+
+```
+
+
+
+## Generate:
+
+
+```bash
+
+
+make proto
+
+```

mono-repo/go-kratos/{{cookiecutter.repo_name}}/api/basic/readme-en.md

@@ -0,0 +1,4 @@
+English | [简体中文](readme.md)
+# api/basic:
+
+- Basic service API definition

mono-repo/go-kratos/{{cookiecutter.repo_name}}/api/readme-en.md

@@ -0,0 +1,18 @@
+English | [简体中文](readme.md)
+# api:
+
+- API for all services:
+- protobuf definition:
+
+## Two management options:
+
+- Centralized management of PROTO API definitions:
+    - It is convenient for client to call
+- Decentralized management PROTO API definition:
+    - Facilitate development by maintainers of a single service
+
+## Compromise:
+
+- Write a sync script.
+- Periodically and automatically synchronize the proto api definitions in each service to the api/ folder.
+

mono-repo/go-kratos/{{cookiecutter.repo_name}}/api/unit/readme-en.md

@@ -0,0 +1,4 @@
+English | [简体中文](readme.md)
+# api/unit:
+
+- Business Unit API Definition

mono-repo/go-kratos/{{cookiecutter.repo_name}}/app/basic/admin/readme-en.md

@@ -0,0 +1,11 @@
+English | [简体中文](readme.md)
+
+# admin manager:
+
+- union
+- Unified admin management background services:
+    - Account system
+    - Login authentication
+    - User roles
+    - User rights
+    

mono-repo/go-kratos/{{cookiecutter.repo_name}}/app/basic/demo/readme-en.md

@@ -0,0 +1,85 @@
+English | [简体中文](readme.md)
+
+# event queue:
+
+- Generic Queue Management: Incident Response
+
+## Application scenarios:
+
+- Some backend services: you don't need to open MQ in the service, you can call it through a simple http api
+- Front-end: Asynchronous capabilities directly through HTTP API.
+- Similar to graphQL, the DB capability is opened to the front end. Here, the MQ capability is opened to the front end.
+- Signature mechanism: Anti-attack
+    - Messages in MQ, add verification, messages with invalid signatures, discard (prevent forgery)
+    - Signature rules: api secret, timestamp, nonce, msg_uuid, data. Anti-replay attack (consumers need to cache msg_uuid, deduplication)
+- API authentication method:
+    - http header: token authentication
+
+- auth authentication:
+    - User authentication: user auth
+    - Service authentication: service auth
+- Permission Control:
+    - User permission: user permission
+    - Service permission: service permission
+
+
+## run:
+
+- run server:
+
+```bash
+
+make run.auto.reload
+
+
+```
+
+- http api test:
+
+```bash
+
+make curl.pub.msg
+
+```
+
+## API List:
+
+- `app/basic/queue/internal/router/router.go`
+
+- Queue write messages: http://localhost:8080/queue/publish/
+    - POST
+    - Makefile has curl example
+
+
+## Function:
+
+### Queue management:
+
+- [ ] queue creation
+- [ ] Queue auth-key generation/authentication
+- [ ] queue destroy
+
+### Producer:
+
+- [ ] Queue Write: HTTP API/ GRPC
+- [ ] Queue read: HTTP API polling / websocket listening
+- [ ] Pass both `task` and `task handler function` as parameters to the server.
+-
+
+### Consumer: (worker)
+
+- [ ] Queue Write: HTTP API/ GRPC
+- [ ] Queue read: HTTP API polling / websocket listening
+- [ ] task handler
+
+### task handler function:
+
+- Generic task handler method
+- Summarize some commonly used task processing methods:
+    - Asynchronously record data to db, and return processing success
+    - Asynchronous send mobile msg
+    - Asynchronous data analysis: generate reports
+    - Asynchronous...
+- Take standardized methods as parameters and provide them to the outside world
+- Similar to `AWS Lambda`: https://aws.amazon.com/cn/lambda/
+

mono-repo/go-kratos/{{cookiecutter.repo_name}}/app/basic/readme-en.md

@@ -0,0 +1,21 @@
+English | [简体中文](readme.md)
+
+
+# app/basic:
+
+- Basic services
+
+
+## illustrate:
+
+- In general business scenarios, public basic services:
+    - user: register/login/
+    - auth:
+    - permission:
+    - role:
+    - vip-account:
+    - security:
+    - push:
+
+
+