go-boilerplate

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

Golang service boilerplate using best practices

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## go-boilerplate
Golang API Service boilerplate using best practices of Clean Architecture.

Responsibility: CRUD and Login Users with JWT.

# Dependencies

- Gin-Gonic
- Swaggo
- go-redis
- GORM (MySQL)
- Golang-Migrate
- Snowflake
- OpenTelemetry
- JWT-Go
- Crypto

## Documentation & Routes

**Swagger**
http://localhost:8000/auth/swagger/index.html

![Print of Swagger](https://raw.githubusercontent.com/felipeagger/go-boilerplate/main/assets/swagger.png)

**Jaeger UI**
http://0.0.0.0:16686/search

![Print of Jaeger](https://raw.githubusercontent.com/felipeagger/go-boilerplate/main/assets/trace-redis.png)

_**On Error**_
![Print of Jaeger](https://raw.githubusercontent.com/felipeagger/go-boilerplate/main/assets/trace-error.png)

_**SQL**_
![Print of Jaeger](https://raw.githubusercontent.com/felipeagger/go-boilerplate/main/assets/trace-sql.png)

## Compose Stack

- API REST
- MySQL
- Redis
- Jaeger

## Execution / Compilation

Set Env. variables of .env-sample:

Compile with:

```
make run
```

Update Swagger Doc:

```
make doc
```

## Tests

```
make test
```

## Path's Organization

_**Clean Arch**_
![Clean Representation](https://raw.githubusercontent.com/felipeagger/go-boilerplate/main/assets/clean-arch.png)

- _**assets**_: static files
- _**cmd**_: binaries entrypoint
- _**internal**_: private packages
    - _**configs**_: env. variables
    - _**usecase**_: business logical/rules
    - _**delivery**_: delivery layer -> http, grpc, messaging
    - _**entity**_: entities / schemas
    - _**repository**_: storage operations, database interface
    - _**service**_: external services call's
- _**pkg**_: public packages
- _**docs**_: Swagger Documentation

go-boilerplate

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README