From 1e988d596bea8265538331394dacad4d49f61b54 Mon Sep 17 00:00:00 2001 From: divakaivan Date: Fri, 14 Mar 2025 11:55:28 +0900 Subject: [PATCH] update readme --- README.md | 90 +++++++++++++++++++++++++++++++++++++++ project-info/k8s-flow.svg | 2 +- 2 files changed, 91 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72431f5..6905dfc 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ - [Monitoring & Metrics](#monitoring--metrics) - [Setup](#setup) - [Future](#future) +- [Directories Structure](#directories-structure) ## API @@ -51,6 +52,8 @@ The dockerised API is lint, tested, and pushed to [Docker Hub](https://hub.docke ## Kubernetes +This is my local cluster setup. + ![k8s-flow](project-info/k8s-flow.svg) **API Traffic Flow** @@ -133,3 +136,90 @@ You should see something like if everything is ok: - try using an ingress controller for exposing the API with K8s - learn more about Go and implement things like the repository pattern for the API - add caching to the API + +### Directories Structure + +``` +└── πŸ“rssagg + └── πŸ“.github + └── πŸ“workflows + └── push_img_to_hub.yaml + └── run_tests.yaml + └── πŸ“docs # Go swagger generated API documentation + └── πŸ“grafana # Grafana dashboards + └── api-logs-dashboard.json + └── k8s-pods-dashboard.json + └── πŸ“internal # Go API internals + └── πŸ“auth + └── auth.go + └── πŸ“database + └── db.go + └── feed_follows.sql.go + └── feeds.sql.go + └── logs.sql.go + └── migration.go + └── models.go + └── posts.sql.go + └── users.sql.go + └── πŸ“handlers + └── api.go + └── err.go + └── feed_follows.go + └── feed.go + └── middleware_auth.go + └── middleware_log.go + └── readiness.go + └── user.go + └── πŸ“mockdb + └── db.go + └── πŸ“rss + └── rss.go + └── scraper.go + └── πŸ“utils + └── json.go + └── models.go + └── πŸ“kubernetes # K8s configs + └── api-deploy-svc.yaml + └── db-deploy-svc.yaml + └── db-pv.yaml + └── db-pvc.yaml + └── db-secret.yaml + └── linter-config.yaml + └── network-policy.yaml + └── πŸ“project-info + └── πŸ“sqlc # Database migrations + └── πŸ“queries + └── feed_follows.sql + └── feeds.sql + └── logs.sql + └── posts.sql + └── users.sql + └── πŸ“schema + └── 001_users.sql + └── 002_users_apikey.sql + └── 003_feeds.sql + └── 004_feed_follows.sql + └── 005_feeds_lastfetchedat.sql + └── 006_posts.sql + └── 007_logging.sql + └── 008_default_user.sql + └── πŸ“tests + └── api_test.go + └── auth_test.go + └── containers.go + └── err_test.go + └── feeds_test.go + └── main_test.go + └── posts_test.go + └── users_test.go + └── .gitignore + └── .pre-commit-config.yaml + └── docker-compose.yaml + └── Dockerfile + └── entrypoint.sh + └── go.mod + └── go.sum + └── main.go + └── README.md + └── sqlc.yaml +``` diff --git a/project-info/k8s-flow.svg b/project-info/k8s-flow.svg index bb2fd33..3a432f8 100644 --- a/project-info/k8s-flow.svg +++ b/project-info/k8s-flow.svg @@ -1 +1 @@ -
API Traffic
API Trafficdeploypod
api
apipvpvcsvc
api-service
api-servicesecretsvc
db-service
db-servicedeploypod
db
dbnetpol
db-access-policy
db-acce...node
local-kind-ctrl-plane
local-kind-...
Monitoring & Metrics
Monitoring & MetricsText is not SVG - cannot display \ No newline at end of file +
API Traffic
API Trafficdeploypod
api
apipvpvcsvc
api-service
api-servicesecret
db-secrets
db-secre...svc
db-service
db-servicedeploypod
db
dbnetpol
db-access-policy
db-acce...node
local-kind-ctrl-plane
local-kind-...
Monitoring & Metrics
Monitoring & MetricsText is not SVG - cannot display \ No newline at end of file