Skip to content

Commit

Permalink
build: add swag generator tool to makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
rsdmike committed Jun 20, 2024
1 parent 8e6d92b commit 4637e08
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,5 @@ migrate-up: ### migration up
bin-deps:
GOBIN=$(LOCAL_BIN) go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
GOBIN=$(LOCAL_BIN) go install go.uber.org/mock/mockgen@latest
GOBIN=$(LOCAL_BIN) go install github.com/swaggo/swag/cmd/swag@latest

14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
![Codecov](https://img.shields.io/codecov/c/github/open-amt-cloud-toolkit/console?style=for-the-badge&logo=codecov)
[![OSSF-Scorecard Score](https://img.shields.io/ossf-scorecard/github.com/open-amt-cloud-toolkit/console?style=for-the-badge&label=OSSF%20Score)](https://api.securityscorecards.dev/projects/github.com/open-amt-cloud-toolkit/console)
[![Discord](https://img.shields.io/discord/1063200098680582154?style=for-the-badge&label=Discord&logo=discord&logoColor=white&labelColor=%235865F2&link=https%3A%2F%2Fdiscord.gg%2FDKHeUNEWVH)](https://discord.gg/DKHeUNEWVH)
# Console

# Console

> Disclaimer: Production viable releases are tagged and listed under 'Releases'. All other check-ins and pre-releases should be considered 'in-development' and should not be used in production
> Disclaimer: Production viable releases are tagged and listed under 'Releases'. All other check-ins and pre-releases should be considered 'in-development' and should not be used in production
## Overview

This is an application that packages the UI, RPS, and MPS into a single executable for use in an enterprise environment.

## Quick start
## Quick start

### For users

Expand All @@ -21,7 +21,7 @@ If you're looking for the latest release of console visit [Github Releases](http

Local development (in Linux or WSL):

To start the service with Postgres:
To start the service with Postgres:

```sh
# Postgres
Expand All @@ -31,17 +31,13 @@ $ make run
```

Download and check out the sample-web-ui:

```
git clone https://github.com/open-amt-cloud-toolkit/sample-web-ui
```

Ensure that the environment file has cloud set to `false` and that the URLs for RPS and MPS are pointing to where you have `Console` running. The default is `http://localhost:8181`. Follow the instructions for launching and running the UI in the sample-web-ui readme.






## Dev tips for passing CI Checks

- Install gofumpt `go install mvdan.cc/gofumpt@latest` (replaces gofmt)
Expand Down

0 comments on commit 4637e08

Please sign in to comment.