update README.md

README.md

@@ -1 +1,163 @@
-# Car shop
+# Golang Clean Web API (Dockerize) with a full sample project (Car Sale project)
+
+## System Design Diagram
+
+![software-engineering.png](docs/files/system_diagram.png)
+
+## Database Design Diagram
+
+![software-engineering.png](docs/files/db_diagram.png)
+
+## Give a Star! :star:
+
+If you like this repo or found it helpful, please give it a star. Thanks!
+
+## Used Tools
+
+1. [Gin as web framework](https://github.com/gin-gonic/gin)
+2. [JWT for authentication and authorization](https://github.com/golang-jwt/jwt)
+3. [Redis for caching](https://github.com/redis/redis)
+4. [Elasticsearch for logging database](https://github.com/elastic/elasticsearch)
+5. [Beat for log shipping](https://github.com/elastic/beats)
+6. [Kibana as log viewer](https://github.com/elastic/kibana)
+7. [Postgresql as main database engine](https://github.com/postgres/postgres)
+8. [PgAdmin as database management tool](https://github.com/pgadmin-org/pgadmin4)
+9. [Prometheus for metric database](https://github.com/prometheus/prometheus)
+10. [Grafana for metric dashboards](https://github.com/grafana/grafana)
+11. [Validator for endpoint input Validation](https://github.com/go-playground/validator)
+12. [Viper for configurations](https://github.com/spf13/viper)
+13. [Zap for logging](https://github.com/uber-go/zap)
+14. [Zerolog for logging](https://github.com/rs/zerolog)
+15. [Gorm as ORM](https://github.com/go-gorm/gorm)
+16. [Swagger for documentation](https://github.com/swaggo/swag)
+17. Docker compose for run project with all dependencies in docker
+
+## How to run
+
+### Docker start
+
+```
+docker compose -f "docker/docker-compose.yml" up -d --build
+```
+
+#### Web API
+
+##### Run local manually [http://localhost:5005](http://localhost:5005)
+
+##### Run in docker [http://localhost:9001](http://localhost:9001)
+
+```
+Token Url: http://localhost:5005/api/v1/users/login-by-username
+Username: admin
+Password: 12345678
+```
+
+#### Kibana
+
+##### [http://localhost:5601](http://localhost:5601)
+
+```
+Username: elastic
+Password: @aA123456
+```
+
+#### Grafana
+
+##### [http://localhost:3000](http://localhost:3000)
+
+```
+Username: admin
+Password: foobar
+```
+
+#### PgAdmin
+
+##### [http://localhost:8090](http://localhost:8090)
+
+```
+Username: h.naimaei@gmail.com
+Password: 123456
+```
+
+Postgres Server info:
+
+```
+Host: postgres_container
+Port: 5432
+Username: postgres
+Password: admin
+```
+
+#### Prometheus
+
+##### [http://localhost:9090](http://localhost:9090)
+
+### Docker Stop
+
+```
+docker compose --file 'docker/docker-compose.yml' --project-name 'docker' down
+```
+
+### Linux
+
+0. build Project and copy configuration
+
+```
+/src > go build -o ../prod/server ./cmd/main.go
+/src > mkdir ../prod/config/ && cp config/config-production.yml ../prod/config/config-production.yml
+```
+
+1. Create systemd unit
+
+```
+sudo vi /lib/systemd/system/go-api.service
+```
+
+2. Service config
+
+```
+[Unit]
+Description=go-api
+
+[Service]
+Type=simple
+Restart=always
+RestartSec=20s
+ExecStart=/home/hamed/github/golang-clean-web-api/prod/server
+Environment="APP_ENV=production"
+WorkingDirectory=/home/hamed/github/golang-clean-web-api/prod
+[Install]
+WantedBy=multi-user.target
+```
+
+3. Start service
+
+```
+sudo systemctl start go-api
+```
+
+4. Stop service
+
+```
+sudo systemctl stop go-api
+```
+
+5. Show service logs
+
+```
+sudo journalctl -u go-api -e
+```
+
+## Project preview
+
+## Swagger
+
+![software-engineering.png](docs/files/swagger.png)
+
+## Grafana
+
+![software-engineering.png](docs/files/grafana.png)
+
+## Kibana
+
+![software-engineering.png](docs/files/kibana.png)