Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nirsht committed Feb 9, 2022
1 parent d6e91a3 commit 35daf79
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@
# validkube

## About this project
### About this project

Validkube combines the best open-source tools to help ensure Kubernetes YAML best practices, hygiene & security.

---
### Capabilities:

- **Validate** - Verify your Kubernetes configuration files @[kubeval](https://github.com/instrumenta/kubeval)
- **Clean** - Remove clutter from your Kubernetes manifests @[kubectl-neat](https://github.com/itaysk/kubectl-neat)
- **Secure** - Scan your YAML code for security vulnerabilities @[trivy](https://github.com/aquasecurity/trivy)

Validkube is an open-source site, so please feel free to add more tools or capabilities. :)

## Prerequisites

### Prerequisites
---

- AWS CLI with access to your AWS
- Yarn
- NPM
- Serverless CLI
- Golang v1.17

## Deploy

---

### Deploy backend serverless
Deploy backend:

```bash
make deploy
Expand All @@ -27,14 +38,16 @@ In order to update web domain:
aws ssm put-parameter --name /validkube/config/allowed_origin --type String --value {frontend-domain} --overwrite
```

In order to deploy frontend:
Deploy frontend:

```bash
cd frontend
netlify deploy --prod
```

# Local environment
## Local environment

---

In order to run this locally, specify 'ALLOWED_ORIGIN' environment variable to 'http://localhost:3000'

Expand All @@ -44,13 +57,13 @@ Example in Linux:
export ALLOWED_ORIGIN=http://localhost:3000
```

In order to start backend run:
In order to start backend:

```bash
go run backend/development/localdev.go
```

In order to start frontend run:
In order to start frontend:

```bash
cd frontend
Expand Down

0 comments on commit 35daf79

Please sign in to comment.