Revise README.md

backend/README.md

@@ -1,56 +1,89 @@
 # Backend of Flamingo Armond
+
 Backend server implementation for Flamingo Armond by Go.
 
 # Precondition
+
 - Go 1.22.5
 - Echo v4.12.0
 - Gorm v1.25.10 (ORM)
 - Goose v3 (Data migration)
 - gqlgen v0.17.49 (GraphQL code generator and framework)
 
 # Set up
+
 ## Install Goose
+
 ```
 go install github.com/pressly/goose/v3/cmd/goose@latest
 ```
 
 ## Install libraries
+
 ```
 go install
 ```
 
+## Create `.env`
+
+Copy `.env.example` and create `.env`.
+
+| Keys           | Discription                                |
+|:---------------|:-------------------------------------------|
+| PORT           | Application Port                           | 
+| GO_ENV         | Application environment. Dev or Production | 
+| GQL_COMPLEXITY | GraphQL Complexity                         |
+| PG_HOST        | Postgres Host name                         |
+| PG_USER        | Database User                              |
+| PG_PASSWORD    | Database Password                          |
+| PG_DBNAME      | Database Name                              |
+| PG_PORT        | Postgres Port                              |
+| PG_SSLMODE     | SSL Mode of Postgres                       
+
 # Test
+
 ## How to Run All Tests
+
 ```
 go clean -testcache
 go test -v ./...
 ```
 
 # How to run Locally
-At the root directory, run 
+
+At the root directory, run
+
 ```
 docker compose up --build
 ```
 
 # Generators
+
 This backend uses some generated code. Here are the steps to generate code.
 
 ## Generate GraphQL
+
 1. Revise table schemas under `/backend/db/migrations`
 1. Revise GraphQL Schemas in `/backend/graph/schema.graphqls` accordingly.
 1. At `/backend`, run `make gen`. It will generate `generated.go`, `resolver.go` and `schema.resolvers.go` accordingly.
 
 ## Generate Parser for Loading Flashcards' Texts
+
 1. Revise `/backend/pkg/notion/parser.y`
 2. At `/backend`, run `make parsergen`
 
 # Tips
+
 ## How to generate GraphQL Model under /graph/model
-Right under the 
+
+Right under the root, run below.
+
 ```
  go run ./cmd/gqlgenerate
 ```
+
 ## How to see the Make Commands
+
 ```
 make help
 ```
@@ -62,20 +95,25 @@ make help
     ```azure
     export PATH=$PATH:$(go env GOPATH)/bin
     ```
-   
+
 ## How to Access the Docker Image
+
 Run `docker images` and get `IMAGE ID`
+
 ```
  docker run -it <IMAGE ID> /bin/sh  
 ```
 
 ## Postgres SQL utilities
+
 ### Show the list of databases
+
 ```
 SELECT datname FROM pg_database;
 ```
 
 ### Show users of the database
+
 ```
 SELECT usename FROM pg_catalog.pg_user;
 ```