https://github.com/err0r500/go-realworld-clean
a clean architecture implementation of the realworldapp : https://github.com/gothinkster/realworld
https://github.com/err0r500/go-realworld-clean
clean-architecture clean-code ddd ddd-architecture example-project go golang hexagonal-architecture ports-and-adapters realworld realworld-backend testing
Last synced: 2 months ago
JSON representation
a clean architecture implementation of the realworldapp : https://github.com/gothinkster/realworld
- Host: GitHub
- URL: https://github.com/err0r500/go-realworld-clean
- Owner: err0r500
- License: mit
- Created: 2018-07-22T19:53:26.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-05T02:05:00.000Z (about 2 years ago)
- Last Synced: 2024-08-01T21:47:41.246Z (11 months ago)
- Topics: clean-architecture, clean-code, ddd, ddd-architecture, example-project, go, golang, hexagonal-architecture, ports-and-adapters, realworld, realworld-backend, testing
- Language: Go
- Homepage:
- Size: 252 KB
- Stars: 514
- Watchers: 16
- Forks: 82
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
> ### Golang clean-architecture codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.
### [Demo](https://github.com/gothinkster/realworld) [RealWorld](https://github.com/gothinkster/realworld)
This codebase was created to demonstrate a fully fledged fullstack application built with go including CRUD operations, authentication, routing, pagination, and more.
We've gone to great lengths to adhere to the go community styleguides & best practices.
For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
[](https://travis-ci.org/err0r500/go-realworld-clean)
[](https://bettercodehub.com/)
[](https://www.codacy.com/app/Err0r500/go-realworld-clean?utm_source=github.com&utm_medium=referral&utm_content=err0r500/go-realworld-clean&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/err0r500/go-realworld-clean)
# How it works
## Clean Architecture :
Layers ( from the most abstract to the most concrete ) :
- domain : abstract data structures
- uc : "use cases", the pure business logic
- implem : implementations of the interfaces used in the business logic (uc layer)
- infra : setup/configuration of the implementation
#### Golden rules :
- a layer never imports something from a layer below it
- 3rd-party libraries are forbidden in the 2 topmost layers
#### Benefits :
- flexibility
- testability
# Getting started
### Build the app
```
make
```
### Run the app
```bash
./go-realworld-clean
```
### Run the integration tests
Start the server with an existing user
```
./go-realworld-clean --populate=true
```
In another terminal, run the tests against the API
```
newman run api/Conduit.postman_collection.json \
-e api/Conduit.postman_integration_test_environment.json \
--global-var "[email protected]" \
--global-var "PASSWORD=password"
```
# Additional
## Make Targets
The version is either `0.1.0` if no tag has ever been defined or the latest
tag defined. The build number is the SHA1 of the latest commit.
- **make**: Builds and injects version/build in binary
- **make init**: Sets the pre-commit hook in the repository
- **make docker**: Build docker image and tag it with both `latest` and version
- **make latest**: Build docker image and tag it only with `latest`
- **make test**: Executes the test suite
- **make mock**: Generate the necessary mocks
- **make clean**: Removes the built binary if present