add readme file

Author: Mubangizi

.env.example

@@ -1,3 +1,6 @@
 FLASK_APP_SECRET=
+FLASK_APP_SALT=
+JWT_SALT=
 FLASK_APP=server.py
-FLASK_ENV=
+FLASK_ENV=development
+PRODUCT_BASE_URL=

.github/workflows/prod.yml

@@ -6,9 +6,6 @@ on:
     types:
       - released
       - prereleased
-  push:
-    branches:
-      - deploy/gcp
 
 jobs:
   build:
@@ -22,7 +19,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: deploy/gcp # Reference branch
+          ref: master # Reference branch
 
       - name: Install (Buildx)
         uses: docker/setup-buildx-action@v3

.github/workflows/staging.yml

@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - master
+      - deploy/gcp
 
   workflow_dispatch:
 

ReadMe.md

@@ -0,0 +1,48 @@
+# Crane Cloud Monitoring API
+
+[![Prod](https://github.com/crane-cloud/monitoring-api/actions/workflows/prod.yml/badge.svg)](https://github.com/crane-cloud/monitoring-api/actions/workflows/prod.yml)
+
+The Crane Cloud Monitoring API provides a backend service for monitoring resource usage (CPU, memory, network) within a Kubernetes environment. It interfaces with Prometheus to fetch and aggregate metrics data.
+
+## Features
+
+- RESTful API endpoints to fetch metrics for projects and applications.
+- Integration with Prometheus for metrics collection.
+- Docker containerization for easy deployment and scaling.
+- Helm charts for Kubernetes deployments.
+
+## Prerequisites
+
+- Docker and Docker Compose
+- Python 3.10
+- Helm 3 for Kubernetes deployment
+- Access to a Kubernetes cluster (for staging/production environments)
+
+## Local Development Setup
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/crane-cloud/monitoring-api.git
+   cd monitoring-api
+   ```
+
+2. **Environment Variables:**
+
+   Copy the `.env.example` to `.env` and modify the environment variables according to your local setup.
+
+3. **Start the application:**
+
+   Use Docker Compose to build and run the local development environment:
+
+   ```bash
+   make start
+   ```
+
+   This command builds the Docker image and starts the services defined in `docker-compose.yml`.
+
+## API Documentation
+
+Swagger documentation is available once the application is running, accessible at `/apidocs`.
+
+