https://github.com/aniskhan001/university
A sample project in Go that tries to follow CLEAN architecture, SOLID principle, and 12 factor methodology
https://github.com/aniskhan001/university
12-factor clean-architecture go golang solid-principles
Last synced: 3 months ago
JSON representation
A sample project in Go that tries to follow CLEAN architecture, SOLID principle, and 12 factor methodology
- Host: GitHub
- URL: https://github.com/aniskhan001/university
- Owner: aniskhan001
- Created: 2021-01-10T14:13:16.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-22T16:41:21.000Z (4 months ago)
- Last Synced: 2026-02-22T21:30:52.276Z (4 months ago)
- Topics: 12-factor, clean-architecture, go, golang, solid-principles
- Language: Go
- Homepage:
- Size: 1.4 MB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# University [WIP] 🎓
A sample project in Go that tries to follow:
- [CLEAN architecture][clean-architecture]
- [SOLID design principle][solid-design-principle]
- [12-factor methodology][12-factor-app]
This application offers to manage entities(departments, clubs, teachers, students, etc.) in a university by providing a REST API.
## Project Structure
The project is separated into different layers. Outside layers can be dependant on the inner layers. But the inner layers should not know the implementation details of outer layers. The flow of data can be bidirectional, but this does not mean that the inner layers are dependant on the outer layers.
_
Fig: CLEAN architecture way of representing this application
_
### Models (domain centric)
### Use cases (domain centric)
### Repositories (database)
### Presenters
### Infrastructure
### Delivery
## Configuration
- This project uses `.editorconfig`
- This project uses a separate `dev.Dockerfile` for hot reload
- This project uses a Relational Database (MySQL) to store data & information
- This project uses `infrasctructure/config/config.local.yml` to load application configuration
## Development
```bash
make run
```
This will boot up application dependencies (DB, cache, etc.) in the background with `docker-compose`, and then run the application container in the foreground so we can watch the logs. The default `Dockerfile` is for production use, while `dev.Dockerfile` is being used for local development.
## Hot Reload
To pick up the changes in the running container, this project uses [CompileDaemon][compile-daemon]. It accepts the `go build` command as an argument.
```Dockerfile
ENTRYPOINT ["CompileDaemon", "--build=go build -mod=mod"]
```
Whenever changes are detected, it tries to run the build command again so that it can restart the server. To detect the changes, a volume is attached to the server container, which mounts host files to that volume.
```yml
volumes:
- ./:/project
```
## TO-DO
- [ ] Authentication
- [ ] Caching mechanism
- [ ] Deployment configuration
- [ ] Detail presentation of data (actual value instead of IDs) in API response
- [ ] Unit tests
[clean-architecture]: https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html
[12-factor-app]: https://en.wikipedia.org/wiki/Twelve-Factor_App_methodology
[solid-design-principle]: https://en.wikipedia.org/wiki/SOLID
[compile-daemon]: https://github.com/githubnemo/CompileDaemon