Skip to content

Commit

Permalink
feat: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
venkatamutyala committed Jan 4, 2025
1 parent b49d598 commit bec0948
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# tools-api
This FastAPI app has various utilities to help streamline local development for Platform Engineers that are working on the GlueOps Platform. This tool is not meant for customers or any end users of the GlueOps Platform.

## Setup

1. Launch codespace
2. Configure environment variables (see below)
3. Run `devbox run dev` and follow outputted steps to get started.

### Required environment variables:

```bash
AWS_GLUEOPS_ROCKS_ORG_ACCESS_KEY
AWS_GLUEOPS_ROCKS_ORG_SECRET_KEY
AWS_LIGHTSAIL_ACCESS_KEY
AWS_LIGHTSAIL_SECRET_KEY
GITHUB_TOKEN
MINIO_S3_ACCESS_KEY_ID
MINIO_S3_SECRET_KEY
```

0 comments on commit bec0948

Please sign in to comment.