https://github.com/genocs/genocs-library
The enterprise library designed by Genocs
https://github.com/genocs/genocs-library
ddd dotnet-core microservices
Last synced: 10 months ago
JSON representation
The enterprise library designed by Genocs
- Host: GitHub
- URL: https://github.com/genocs/genocs-library
- Owner: Genocs
- License: mit
- Created: 2020-05-11T17:08:09.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T04:17:51.000Z (over 1 year ago)
- Last Synced: 2025-04-14T07:03:09.005Z (about 1 year ago)
- Topics: ddd, dotnet-core, microservices
- Language: C#
- Homepage: https://www.genocs.com
- Size: 3.97 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![License][license-shield]][license-url]
[![Build][build-shield]][build-url]
[![Downloads][downloads-shield]][downloads-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Discord][discord-shield]][discord-url]
[![Gitter][gitter-shield]][gitter-url]
[![Twitter][twitter-shield]][twitter-url]
[![Twitterx][twitterx-shield]][twitterx-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[license-shield]: https://img.shields.io/github/license/Genocs/genocs-library?color=2da44e&style=flat-square
[license-url]: https://github.com/Genocs/genocs-library/blob/main/LICENSE
[build-shield]: https://github.com/Genocs/genocs-library/actions/workflows/build_and_test.yml/badge.svg?branch=main
[build-url]: https://github.com/Genocs/genocs-library/actions/workflows/build_and_test.yml
[downloads-shield]: https://img.shields.io/nuget/dt/Genocs.Microservice.Template.svg?color=2da44e&label=downloads&logo=nuget
[downloads-url]: https://www.nuget.org/packages/Genocs.Microservice.Template
[contributors-shield]: https://img.shields.io/github/contributors/Genocs/genocs-library.svg?style=flat-square
[contributors-url]: https://github.com/Genocs/genocs-library/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Genocs/genocs-library?style=flat-square
[forks-url]: https://github.com/Genocs/genocs-library/network/members
[stars-shield]: https://img.shields.io/github/stars/Genocs/genocs-library.svg?style=flat-square
[stars-url]: https://img.shields.io/github/stars/Genocs/genocs-library?style=flat-square
[issues-shield]: https://img.shields.io/github/issues/Genocs/genocs-library?style=flat-square
[issues-url]: https://github.com/Genocs/genocs-library/issues
[discord-shield]: https://img.shields.io/discord/1106846706512953385?color=%237289da&label=Discord&logo=discord&logoColor=%237289da&style=flat-square
[discord-url]: https://discord.com/invite/fWwArnkV
[gitter-shield]: https://img.shields.io/badge/chat-on%20gitter-blue.svg
[gitter-url]: https://gitter.im/genocs/
[twitter-shield]: https://img.shields.io/twitter/follow/genocs?color=1DA1F2&label=Twitter&logo=Twitter&style=flat-square
[twitter-url]: https://twitter.com/genocs
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/giovanni-emanuele-nocco-b31a5169/
[twitterx-shield]: https://img.shields.io/twitter/url/https/twitter.com/genocs.svg?style=social
[twitterx-url]: https://twitter.com/genocs
# Genocs .NET library
This repo contains a set of libraries to build LOB (Line Of Business) applications. The library is open source and built to be PRODUCTION READY. The library is built on top of .NET9, it is designed and maintained by Genocs.
Packages are available on [NuGet Genocs](https://www.nuget.org/profiles/gioema_nocco).
## The idea
**_Build a software library to be cloud agnostic_**
Building a software library to be cloud agnostic has several advantages. First, it allows developers to create applications that can be deployed on any cloud platform without having to rewrite code or make major changes. This makes it easier for developers to quickly deploy their applications across multiple cloud providers. Additionally, it reduces the cost of development and maintenance since developers don’t have to write separate code for each cloud provider. Finally, it increases the scalability of applications since they can be easily deployed on different cloud platforms with minimal effort.
**_Cloud agnostic by use of Containers_**
The advantages of using containers are numerous. Containers provide a lightweight, portable, and isolated environment for applications to run in, allowing them to be easily moved between different systems. This makes it easier to deploy applications quickly and reliably across different environments. Additionally, containers can help reduce resource consumption by running multiple applications on the same host, as each container is isolated from the others. This helps to improve efficiency and scalability. Finally, containers provide an additional layer of security, as they are isolated from the underlying operating system and other applications.
## Documentation
You can find a useful documentation about how to use the library. The documentation contains the complete set of libraries, template, CLI that altogether make the _genocs ecosystem_ a comprensive set of tools to build enterprise solutions.
Documentation available at [Genocs Blog](https://genocs-blog.netlify.app/library/)
## Infrastructure
In this section you can find the infrastructure components you need to execute the solution. Infrastucture components are the database, the enterprice servise bus, the distributed logging, monitoring, tracing systems along with database and many more.
You can use **Docker compose** to setup the infrastructure components just by running few commands.
```bash
cd ./containers
# Setup the infrastructure.
#Use this file to setup the basic infrastructure components (RabbitMQ, MongoDB)
docker compose -f ./infrastructure.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup Redis and PostgreSQL (no need if you use MongoDB)
docker compose -f ./infrastructure-db.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup monitoring infrastructure components (Prometheus, Grafana, InfluxDB, Jaeger, Seq)
docker compose -f ./infrastructure-monitoring.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup scaling infrastructure components (Fabio, Consul)
docker compose -f ./infrastructure-scaling.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup security infrastructure components (Vault)
docker compose -f ./infrastructure-security.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup sqlserver database (no need if you use PostgreSQL)
docker compose -f ./infrastructure-sqlserver.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup mySql database (no need if you use PostgreSQL)
docker compose -f ./infrastructure-mysql.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup oracle database (no need if you use PostgreSQL)
docker compose -f ./infrastructure-oracle.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup elk stack
docker compose -f ./infrastructure-elk.yml --env-file ./.env --project-name genocs up -d
# Use this file only in case you want to setup AI ML components prepared by Genocs
docker compose -f ./infrastructure-ml.yml --env-file ./.env --project-name genocs up -d
```
`infrastructure.yml` allows to install the basic infrastructure components. They are:
- [RabbitMQ](https://rabbitmq.com)
- [MongoDB](https://mongodb.com)
`infrastructure-db.yml` allows to install Redis and PostgreSQL
- [Redis](https://redis.io)
- [Postgres](https://www.postgresql.org/)
You can check them locally:
- [RabbitMQ](http://localhost:15672): `localhost:15672`
- Redis: `TCP:localhost:6379`
- MongoDB: `TCP:localhost:27017`
- Postgres: `TCP:localhost:5432`
`infrastructure-monitoring.yml` allows to install the monitoring infrastructure components. They are:
- [Aspire](https://learn.microsoft.com/en-us/dotnet/aspire/)
- [Prometheus](https://prometheus.io/)
- [Grafana](https://grafana.com/)
- [InfluxDB](https://www.influxdata.com/)
- [Jaeger](https://www.jaegertracing.io/)
- [Seq](https://datalust.co/seq)
You can find the console locally at:
- [Aspire](localhost:18888): `localhost:18888`
- [Prometheus](localhost:9090): `localhost:9090`
- [Grafana](localhost:3000): `localhost:3000`
- [InfluxDB](localhost:8086): `localhost:8086`
- [Jaeger](localhost:16686): `localhost:16686`
- [Seq](localhost:5341): `localhost:5341`
`infrastructure-scaling.yml` allows to install the scaling infrastructure components composed by a Fabio (Loadbalancer) Service Discovery (Consul) components. They are:
- [Fabio](https://fabiolb.net/)
- [Consul](https://www.consul.io/)
`infrastructure-security.yml` allows to install the security infrastructure components.
Inside the file you can find:
- vault (Hashicorp)
> **NOTE**
>
> The commands above allows to setup infrastructure components, this means you can find all the containers inside the same network `genocs`.
>
> Whenever possible the data are persisted on the host machine by means of volumens, so you can restart the containers without losing data.
```yml
networks:
genocs:
name: genocs-network
driver: bridge
volumes:
rabbitmq-data:
mongo-data:
redis-data:
postgres-data:
influx-data:
grafana-data:
jaeger-data:
seq-data:
vault-data:
elk-data:
fabio-data:
consul-data:
prometheus-data:
ml-data:
```
Remember to add the network configuration inside your docker compose file to setup the network, before running the containers.
## **_Kubernetes cluster_**
You can setup the application inside a Kubernetes cluster.
Check the repo [enterprise-containers](https://github.com/Genocs/enterprise-containers) to setup a Kubernetes cluster.
There you can find scripts, configuration files and documentation to setup a cluster from scratch.
## **_Aspire Integration_**
SOON :rocket:
## Support
Use [**api-workbench**](./api-workbench.rest) inside Visual Studio code with [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) plugin
## Configuration
```json
"app": {
"name": "Demo WebApi",
"service": "demo-service",
"instance": "01",
"version": "v1.0",
"displayBanner": false,
"displayVersion": false
},
"consul": {
"enabled": false,
"url": "http://localhost:8500",
"service": "demo-service",
"address": "docker.for.mac.localhost",
"port": "5070",
"pingEnabled": true,
"pingEndpoint": "healthz",
"pingInterval": 3,
"removeAfterInterval": 3
},
"fabio": {
"enabled": false,
"url": "http://localhost:9999",
"service": "demo-service"
},
"httpClient": {
"type": "fabio",
"retries": 3,
"services": {},
"requestMasking": {
"enabled": true,
"maskTemplate": "*****"
},
"correlationIdHeader": "x-correlation-id"
},
"logger": {
"level": "information",
"excludePaths": [
"/",
"/healthz",
"/alive",
"/metrics"
],
"excludeProperties": [
"api_key",
"access_key",
"ApiKey",
"ApiSecret",
"ClientId",
"ClientSecret",
"ConnectionString",
"Password",
"Email",
"Login",
"Secret",
"Token"
],
"console": {
"enabled": false
},
"elk": {
"enabled": false,
"url": "http://localhost:9200"
},
"file": {
"enabled": false,
"path": "logs/logs.txt",
"interval": "day"
},
"seq": {
"enabled": false,
"url": "http://localhost:5341",
"apiKey": "secret"
},
"azure": {
"enabled": false,
"connectionString": ""
},
"tags": {}
},
"jaeger": {
"enabled": true,
"serviceName": "orders",
"endpoint": "http://localhost:4317",
"protocol": "Grpc",
"processorType": "Batch",
"maxQueueSize": 2048,
"scheduledDelayMilliseconds": 5000,
"exporterTimeoutMilliseconds": 30000,
"maxExportBatchSize": 512
},
"jwt": {
"certificate": {
"location": "certs/localhost.pfx",
"password": "test",
"rawData": ""
},
"issuer": "genocs-identities-service",
"validIssuer": "genocs-identities-service",
"validateAudience": false,
"validateIssuer": true,
"validateLifetime": true,
"expiry": "01:00:00"
},
"metrics": {
"enabled": false,
"influxEnabled": false,
"prometheusEnabled": false,
"influxUrl": "http://localhost:8086",
"database": "test",
"env": "local",
"interval": 5
},
"prometheus": {
"enabled": false,
"endpoint": "/metrics"
},
"mongodb": {
"connectionString": "mongodb://localhost:27017",
"database": "genocs-users-service",
"seed": false
},
"outbox": {
"enabled": false,
"type": "sequential",
"expiry": 3600,
"intervalMilliseconds": 2000,
"inboxCollection": "inbox",
"outboxCollection": "outbox",
"disableTransactions": false
},
"rabbitMq": {
"connectionName": "users-service",
"retries": 3,
"retryInterval": 2,
"conventionsCasing": "snakeCase",
"logger": {
"enabled": false
},
"username": "guest",
"password": "guest",
"virtualHost": "/",
"port": 5672,
"hostnames": [
"localhost"
],
"requestedConnectionTimeout": "00:00:30",
"requestedHeartbeat": "00:01:00",
"socketReadTimeout": "00:00:30",
"socketWriteTimeout": "00:00:30",
"continuationTimeout": "00:00:20",
"handshakeContinuationTimeout": "00:00:10",
"networkRecoveryInterval": "00:00:05",
"exchange": {
"declare": true,
"durable": true,
"autoDelete": false,
"type": "topic",
"name": "users"
},
"queue": {
"declare": true,
"durable": true,
"exclusive": false,
"autoDelete": false,
"template": "users-service/{{exchange}}.{{message}}"
},
"context": {
"enabled": true,
"header": "message_context"
},
"spanContextHeader": "span_context"
},
"redis": {
"connectionString": "localhost",
"instance": "users-service:",
"database": 0
},
"swagger": {
"enabled": false,
"reDocEnabled": false,
"name": "v1",
"title": "API",
"version": "v1",
"routePrefix": "swagger",
"includeSecurity": true
},
"security": {
"certificate": {
"header": "Certificate"
}
},
"azureKeyVault": {
"enabled": false,
"name": "gnx-keyvault",
"managedIdentityId": "secret",
},
"vault": {
"enabled": false,
"url": "http://localhost:8200",
"authType": "token",
"token": "secret",
"username": "user",
"password": "secret",
"kv": {
"enabled": true,
"engineVersion": 2,
"mountPoint": "kv",
"path": "users-service/settings"
},
"pki": {
"enabled": true,
"roleName": "users-service",
"commonName": "users-service.demo.io"
},
"lease": {
"mongo": {
"type": "database",
"roleName": "users-service",
"enabled": true,
"autoRenewal": true,
"templates": {
"connectionString": "mongodb://{{username}}:{{password}}@localhost:27017"
}
}
}
}
```
---
## Demo Application
Inside the library there is a simple demo application you can use to test the library.
Following are the commands to build and run the demo application.
```bash
# Build the solution
dotnet build
# Pack the projects
dotnet pack
# Run project with console
dotnet run --project ./src/Genocs.Core.Demo.WebApi
dotnet run --project ./src/Genocs.Core.Demo.Worker
```
```bash
# To pack the project with nuspec file
cd src/Genocs.Core
dotnet pack -p:NuspecFile=./Genocs.Core.nuspec --no-restore -o .
# To push on nuget
dotnet nuget push
dotnet nuget push *.nupkg -k $NUGET_API_KEY -s $NUGET_SOURCE
```
### How to build Docker Demo images
```bash
# Build webapi
docker build -t genocs/demo-webapi:2.0.0 -t genocs/demo-webapi:latest -f ./demo-webapi.dockerfile .
# Push on Dockerhub
docker push genocs/demo-webapi:2.0.0
docker push genocs/demo-webapi:latest
# Build worker
docker build -t genocs/demo-worker:2.0.0 -t genocs/demo-worker:latest -f ./demo-worker.dockerfile .
# Push on Dockerhub
docker push genocs/demo-worker:2.0.0
docker push genocs/demo-worker:latest
```
---
## **Enterprise Application**
### Application Components
Inside **./src/apps** folder you can find a full-fledged application composed by:
- ApiGateway
- Identity Service
- Order Service
- Product Service
- SignalR Service
In that way you can test the entire flow.
| Component | Description | Container Port | Visibility |
| ---------------- | ------------------------------- | -------------- | --------------------------- |
| ApiGateway | Handles API requests | :5500 | Public |
| Identity Service | Manages user identities | :5510\* | Private through API Gateway |
| Product Service | Manages product information | :5520\* | Private through API Gateway |
| Order Service | Processes orders | :5530\* | Private through API Gateway |
| SignalR Service | Handles real-time communication | :5540\* | Private through API Gateway |
### How to BUILD & RUN the application
The build and run process can be done by using docker-compose.
Pre-requisites:
- Docker
```bash
cd ./src/apps
# Build with docker compose
docker compose -f ./docker-compose.yml -f ./docker-compose.override.yml --env-file ./local.env --project-name genocs build
# *** Before running the solution remember to check ***
# *** if the infrastructure services were setup ***
# Run with docker compose
docker compose -f ./docker-compose.yml --env-file ./local.env --project-name genocs up -d
# Clean Docker cache
docker builder prune
```
Use following to build and push the images one by one
```bash
# Build images
./src/apps/scripts/build-images.sh
# Push images
./src/apps/scripts/push-images.sh
```
### How to deploy the application on Kubernetes
You can deploy the application on Kubernetes cluster.
```bash
# Build images
./src/apps/scripts/deploy-k8s.sh
```
### How to use makefile
Prerequisites:
- make
To install make on MacOS you can use brew
```bash
brew install make
```
To install make on Ubuntu you can use apt
```bash
sudo apt install make
```
To install make on Windows you can use [choco](https://chocolatey.org/)
```bash
choco install make
```
Upon installation you can use the makefile to build, run, deploy the application.
```bash
# Build the solution
make build
```
### How to use Helm chart
Inside the folder **./src/apps/k8s/helm** you can find the Helm chart to deploy the application on Kubernetes.
```bash
cd ./src/apps/k8s/helm
microk8s helm install genocs ./gnxchart
```
### Deploy in a cloud instance
You can deploy Demo Application with one click in Heroku, Microsoft Azure, or Google Cloud Platform:
[
](https://heroku.com/deploy?template=https://github.com/heartexlabs/label-studio/tree/heroku-persistent-pg)
[
](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fheartexlabs%2Flabel-studio%2Fmaster%2Fazuredeploy.json)
[
](https://deploy.cloud.run)
## License
This project is licensed with the [MIT license](LICENSE).
## Changelog
View Complete [Changelog](https://github.com/Genocs/microservice-template/blob/main/CHANGELOG.md).
## Community
- Discord [@genocs](https://discord.com/invite/fWwArnkV)
- Facebook Page [@genocs](https://facebook.com/Genocs)
- Youtube Channel [@genocs](https://youtube.com/c/genocs)
## Support
Has this Project helped you learn something New? or Helped you at work?
Here are a few ways by which you can support.
- ⭐ Leave a star!
- 🥇 Recommend this project to your colleagues.
- 🦸 Do consider endorsing me on LinkedIn for ASP.NET Core - [Connect via LinkedIn](https://www.linkedin.com/in/giovanni-emanuele-nocco-b31a5169/)
- ☕ If you want to support this project in the long run, [consider buying me a coffee](https://www.buymeacoffee.com/genocs)!
[](https://www.buymeacoffee.com/genocs)
## Code Contributors
This project exists thanks to all the people who contribute. [Submit your PR and join the team!](CONTRIBUTING.md)
[](https://github.com/genocs/genocs-library/graphs/contributors)
## Financial Contributors
Become a financial contributor and help me sustain the project. [Support the Project!](https://opencollective.com/genocs/contribute)
## Acknowledgements
- [devmentors](https://github.com/devmentors)
- [abp](https://github.com/abpframework)