Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prajjwalyd committed Jul 13, 2024
1 parent 5084a99 commit 40f84c3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# LinkLoom🔗

LinkLoom is a microservive application designed to provide URL shortening, QR code generation, analytics logging, and an integrated API service. The app is deployed on a local Kubernetes cluster using Minikube, with Helm managing the deployments of MongoDB, PostgreSQL, Prometheus, and Grafana for monitoring.
LinkLoom is a microservice application designed to manage URLs, providing URL shortening, QR code generation, analytics logging, and an integrated API service. These services are loosely coupled, and the application is deployed on a local Kubernetes cluster using Minikube (due to the cost considerations of EKS 😅). Helm is utilized to manage deployments of MongoDB and PostgreSQL, alongside Prometheus and Grafana for monitoring purposes.

[![Tech Stack](https://skillicons.dev/icons?i=flask,python,go,postgres,mongodb,docker,githubactions,prometheus,grafana,k8s)](https://skillicons.dev)
[![Tech Stack](https://skillicons.dev/icons?i=flask,python,go,postgres,mongodb,githubactions,docker,k8s,prometheus,grafana)](https://skillicons.dev)

---
## Architecture Overview:
Expand Down Expand Up @@ -107,6 +107,9 @@ graph LR

## Setup and Deployment:

> If you're seeking the quickest and most straightforward method to get the app up and running, I suggest setting it up in a GitHub codespace.

#### Local Kubernetes Cluster Setup (Minikube):
[Minikube installation guide](https://minikube.sigs.k8s.io/docs/start/)
```
Expand All @@ -128,16 +131,16 @@ helm install my-mongo bitnami/mongodb --set auth.rootPassword=example,auth.usern
helm install my-postgresql bitnami/postgresql -f values.yaml
```

#### Deploy Prometheus and Grafana:
#### Deploy Services:
Apply Kubernetes manifests (`k8s/` directory)
```
helm install prometheus prometheus-community/prometheus -f prometheus.yml
helm install grafana grafana/grafana
kubectl apply -f k8s
```

#### Deploy LinkLoom Application:
Apply Kubernetes manifests (`k8s/` directory)
#### Deploy Prometheus and Grafana:
```
kubectl apply -f k8s
helm install prometheus prometheus-community/prometheus -f prometheus.yml
helm install grafana grafana/grafana
```

#### Verify Deployment:
Expand Down
File renamed without changes.

0 comments on commit 40f84c3

Please sign in to comment.