Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabianogoes/fiap-tech-challenge-kitchen-api
Kitchen is a microservices of fiap-tech-challenge-restaurant project
https://github.com/fabianogoes/fiap-tech-challenge-kitchen-api
clean-architecture clean-code docker docker-compose gin-gonic ginkgo golang gomega hexagonal-architecture mongodb sonarcloud sonarqube testify testify-mocking testing
Last synced: about 1 month ago
JSON representation
Kitchen is a microservices of fiap-tech-challenge-restaurant project
- Host: GitHub
- URL: https://github.com/fabianogoes/fiap-tech-challenge-kitchen-api
- Owner: fabianogoes
- Created: 2024-06-07T05:17:35.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T23:34:28.000Z (2 months ago)
- Last Synced: 2024-10-02T05:22:06.536Z (about 2 months ago)
- Topics: clean-architecture, clean-code, docker, docker-compose, gin-gonic, ginkgo, golang, gomega, hexagonal-architecture, mongodb, sonarcloud, sonarqube, testify, testify-mocking, testing
- Language: Go
- Homepage: https://github.com/fabianogoes/fiap-tech-challenge-restaurant-api
- Size: 143 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FIAP challenge - Kitchen
[](https://github.com/fabianogoes/fiap-tech-challenge-kitchen-api/actions/workflows/ci-cd.yml)
[](https://sonarcloud.io/summary/new_code?id=fabianogoes_fiap-tech-challenge-kitchen-api)
[](https://sonarcloud.io/summary/new_code?id=fabianogoes_fiap-tech-challenge-kitchen-api)
## Project Architecture by Clean Architecture
- `app/web`: diretório para os principais pontos de entrada, injeção dependência ou comandos do aplicativo. O subdiretório ‘web’ contém o ponto de entrada principal a API REST.
- `domain/entities`: diretório que contém modelos/entidades de domínio que representam os principais conceitos de negócios.
- `domain/usecases`: diretório que contém Serviços de Domínio ou Use Cases.
- `domain/ports`: diretório que contém ‘interfaces’ ou contratos definidos que os adaptadores devem seguir.
- `frameworks/rest`: diretório que contém os controllers e manipulador de requisições REST.
- `frameworks/rest/dto`: diretório que contém objetos/modelo de request e response.
- `frameworks/repository`: diretório que contém adaptadores de banco de dados exemplo para PostgreSQL.
- `frameworks/repository/dbo`: diretório que contém objetos/entidades de banco de dados.
- `.infra`: diretório que contém arquivos de infrainstrutura
- `.infra/kubernetes`: diretório que contém os manifestos kubernetes
- `.infra/terraform`: diretório que contém os arquivos terraform para provisionar a infra do projeto
## Stack
- [x] [Go][0]
- [x] [Domain-Driven Design][6]
- [x] [Hexagonal Architecture][5]
- [x] [Gin Web Framework][1] - Routes, JSON validation, Error management, Middleware support
- [x] [MongoDB][3] - Database persistence
- [x] [GORM ORM library for Golang][2]
- [x] [Slog](https://pkg.go.dev/log/slog) - Package slog provides structured logging, in which log records include a message, a severity level, and various other attributes expressed as key-value pairs.
- [x] [GoDotEnv](https://github.com/joho/godotenv) - A Go (golang) port of dotenv project (which loads env vars from a .env file).
## Issues
- [ ] [gin-swagger](https://github.com/swaggo/gin-swagger) - gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
- [ ] [swag](https://github.com/swaggo/swag) - Swag converts Go annotations to Swagger Documentation 2.0
- [ ] [CORS gin's middleware](https://github.com/gin-contrib/cors) - Gin middleware/handler to enable CORS support.
## Development
Dependencies
- [Go Installation](https://go.dev/doc/install)
Check for go version 1.21.3
```shell
go version
```
Preparing app
```shell
git clone [email protected]:fabianogoes/fiap-tech-challenge-kitchen-api.git
cd fiap-tech-challenge-kitchen-api
go mod tidy
````
### Running
```shell
docker-compose up -d postgres && go run app/web/main.go
```
## Testing using Docker/Docker Compose
```shell
docker-compose up -d
curl --request GET --url http://localhost:8020/health
## response
{"status":"UP"}
```
[Insomnia Collection](.utils/fiap-tech-challenge-Insomnia.json)
## Docker Commands
```shell
docker login -u=fabianogoes
docker build -t fabianogoes/kitchen-api:latest .
docker tag fabianogoes/kitchen-api:latest fabianogoes/kitchen-api:latest
docker push fabianogoes/kitchen-api:latest
```
## Run Go test
```shell
go test -v ./...
```
[0]: https://go.dev/
[1]: https://gin-gonic.com/
[2]: https://www.mongodb.com/
[3]: https://www.postgresql.org/
[5]: https://alistair.cockburn.us/hexagonal-architecture/
[6]: https://www.amazon.com/dp/0321125215?ref_=cm_sw_r_cp_ud_dp_0M66DHP14SJ5GBBJCRNP