Skip to content

Commit

Permalink
add documentation on development dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
bozerkins committed Jul 21, 2023
1 parent 45b66fc commit 36e2159
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ They can be installed by running:
pre-commit install
```

To compile the project locally, you would also need to generate mocks (for testing) and swagger docs (for api documentation).

### Mock classes

To generate mock classes for unit tests, first install `gomock` tool.
Expand All @@ -24,6 +26,20 @@ Then run the mock generation from interfaces.
make mocks
```

### Swagger documentation

To generate documentation dependencies, first install `swag` tool.

```shell
go install github.com/swaggo/swag/cmd/swag@latest
```

Then run the swagger doc generation.

```shell
make docs
```

> Note: you need to run this only when you're changing the interfaces
## Back-End Development
Expand Down

0 comments on commit 36e2159

Please sign in to comment.