bullish/README.md
Ameya Shenoy 206d7e42c0
docs: add readme
Signed-off-by: Ameya Shenoy <shenoy.ameya@gmail.com>
2021-02-12 16:18:08 +05:30

2.4 KiB

Bullish

A simple webapp to explore Bhav Copy Equity data

License: AGPL v3

Backend: Docker Pulls - Backend Docker Image Size Backend (tag)

Frontend Docker Pulls - Frontend Docker Image Size Frontend (tag)

Usage

  • Local setup is supported via Docker Compose
docker-compose up -d

Build

  • Build images for dev
docker-compose build
  • Build images for prod
./prod-build.sh

Logging

To get the logs of all containers

docker logs -f

To get the logs of a particular container

docker logs -f container-name

Here container-name can be either of backend, frontend, redis, postgresql, rqworker or rqscheduler.

Deploy

The recommended way for deploy is on Kubernetes. You can find the related files in k8s directory.

  • One time deploy
# Deploy ingress
kubectl apply -f k8s/ingress/ingress-https.yaml

# Deploy Postgres and Redis DB
kubectl apply -f k8s/app/redis.yaml
kubectl apply -f k8s/app/postgres.yaml

# Deploy Backend
kubectl apply -f k8s/app/backend.yaml
kubectl apply -f k8s/app/rqworker.yaml
kubectl apply -f k8s/app/rqscheduler.yaml

# Deploy Frontend
kubectl apply -f k8s/app/frontend.yaml
  • Subsequent deploys can be done by rolloing out a restart since all pods have a imagePullPolicy set to Always
# Push containers to Docker Hub and Deploy to K8s
./prod-deploy.sh

License

The code in this repository has been released under the GNU Affero General Public License v3

Attributions