Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Linesmerrill committed May 15, 2022
1 parent 4bed9af commit f2f6d13
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,15 @@ To view the routes, check our swagger [here](https://police-cad-api.herokuapp.co
## Run

1. Duplicate `.env.example` and rename the new file to `.env`. Edit to your configurations.
2. ```make run```
```
make run
```

## Generate Mocks before committing code

```make mocks```
```
make mocks
```

## Rest Request Examples:

Expand All @@ -34,11 +38,15 @@ Import our Postman collection here: [Postman Collection](https://github.com/Line

To build the docs run:

```make swagger```
```
make swagger
```

To run the docs locally:

```make serve-swagger```
```
make serve-swagger
```

To update the docs navigate to `/docs/docs.go` and follow along with the swagger annotations and comments to
document your routes and parameters.
Expand Down

0 comments on commit f2f6d13

Please sign in to comment.