Skip to content

Commit

Permalink
docs: update swagger annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
rsdmike committed Jul 9, 2024
1 parent 2d3bc4f commit 74a30ee
Show file tree
Hide file tree
Showing 13 changed files with 5,237 additions and 257 deletions.
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ compose-down: ### Down docker compose
.PHONY: compose-down

swag-v1: ### swag init
swag init -g internal/controller/http/v1/router.go
swag init -g internal/controller/http/router.go
.PHONY: swag-v1

run: ### run app
Expand Down Expand Up @@ -88,3 +88,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

17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
![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'. Console is under development. **The current available tags for download are Alpha version code and should not be used in production.** For these Alpha tags, certain features may not function yet, visual look and feel may change, or bugs/errors may occur. Follow along our [Feature Backlog for future releases and feature updates](https://github.com/orgs/open-amt-cloud-toolkit/projects/10).
Expand All @@ -17,21 +17,21 @@ Console is an application that provides a 1:1, direct connection for AMT devices

<br>

## Quick start
## Quick start

### For Users

1. Find the latest release of Console under [Github Releases](https://github.com/open-amt-cloud-toolkit/console/releases/latest).

2. Download the appropriate binary assets for your OS and Architecture under the *Assets* dropdown section.
2. Download the appropriate binary assets for your OS and Architecture under the _Assets_ dropdown section.

3. Run Console.

### For Developers

Local development (in Linux or WSL):

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

```sh
# Postgres
Expand All @@ -41,17 +41,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 All @@ -60,7 +56,6 @@ Ensure that the environment file has cloud set to `false` and that the URLs for
- Ensure all unit tests pass with `go test ./...`
- Ensure code has been linted with `docker run --rm -v ${pwd}:/app -w /app golangci/golangci-lint:latest golangci-lint run -v`


## Additional Resources

- For detailed documentation and Getting Started, [visit the docs site](https://open-amt-cloud-toolkit.github.io/docs).
Expand All @@ -71,4 +66,4 @@ Ensure that the environment file has cloud set to `false` and that the URLs for

- Need additional support or want to get the latest news and events about Open AMT? Connect with the team directly through Discord.

[![Discord Banner 1](https://discordapp.com/api/guilds/1063200098680582154/widget.png?style=banner2)](https://discord.gg/DKHeUNEWVH)
[![Discord Banner 1](https://discordapp.com/api/guilds/1063200098680582154/widget.png?style=banner2)](https://discord.gg/DKHeUNEWVH)
Loading

0 comments on commit 74a30ee

Please sign in to comment.