https://github.com/igor-u/jambo
https://github.com/igor-u/jambo
aspnet-core containerization csharp docker dotnet efcore rest solar-energy web webapi
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/igor-u/jambo
- Owner: igor-u
- License: mit
- Created: 2024-12-22T14:46:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-04T23:02:18.000Z (over 1 year ago)
- Last Synced: 2025-03-08T22:32:49.818Z (over 1 year ago)
- Topics: aspnet-core, containerization, csharp, docker, dotnet, efcore, rest, solar-energy, web, webapi
- Language: C#
- Homepage:
- Size: 1.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jambo Web API
## Overview
This project serves as an experimental exploration of the ASP.NET Core framework within the context of photovoltaic solar energy. It focuses on three core model classes: solar panels, solar inverters, and solar power plants.
## Entity Relationship Diagram
```mermaid
%%{init: {
"theme": "default",
"themeCSS": [
".er.relationshipLabel { fill: white ; }",
".er.attributeBoxEven { fill : black; }",
".er.attributeBoxOdd { fill : black; }",
".er.attributeBoxEven { stroke : #e0e000; }",
".er.attributeBoxOdd { stroke : #e0e000; }",
".er.entityLabel { fill: white; }",
".er.relationshipLabelBox { fill: transparent; }",
".er.entityBox { fill: black; }",
".er.entityBox { stroke: #e0e000; }"
]
}}%%
erDiagram
SolarPowerPlant o|--|{ SolarPanel : has
SolarPowerPlant o|--|{ SolarInverter : has
SolarPowerPlant {
bigint Id PK
varchar(19) Coordinates
int TotalSolarPanelWattage
int TotalSolarInverterWattage
}
SolarPanel{
varchar(12) SerialNumber PK
int Power
bigint SolarPowerPlantId
}
SolarInverter{
varchar(12) SerialNumber PK
int RatedPower
int PeakPower
bigint SolarPowerPlantId
}
```
## Tools
- [.NET](https://dotnet.microsoft.com)
- [MySQL](https://www.mysql.com)
- [Docker](https://www.docker.com)
- [Postman](https://www.postman.com)
## Architecture
For this practice, MVC and REST were utilized separately. The view layer is responsible for displaying data (using the GET method), while the POST method is accessible through API testing platforms such as Postman or Insomnia. A collection of requests can be found in the [Jambo.postman_collection.json](https://github.com/igor-u/jambo-web-api/blob/main/Jambo.postman_collection.json) file. The collection can be imported into either tool to execute the requests after running the project.
## Objectives
- Learn about the C# programming language
- Learn more about object relational mapping
- Learn how to containerize a .NET application.
## Database
This project utilizes MySQL as the primary database. The connection between the ASP.NET application and the MySQL server is established using [Pomelo.EntityFrameworkCore.MySql](https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql), an open-source provider for Entity Framework Core that supports MySQL.
* Server: Localhost was used.
* MySQL Server: Ensure the MySQL server is operational:
**To create the database, along with its tables**:
- Navigate to the project's `src/` directory in your terminal.
- Apply migrations:
```
dotnet ef database update
```
## Tests
To run the tests in this .NET application, execute the following command in the project's `src/` directory:
```
dotnet test
```
## Running the Project
This project can be run in two ways:
1. Using `dotnet run`
- Navigate to the project's `src/` directory in your terminal.
- Run the following command:
```
dotnet run
```
The application will start and be accessible through `http://localhost:5171`.
2. Using Docker
- Navigate to the project's `src/` directory in your terminal.
- Build the Docker image:
```
docker build -t jambo-web-api .
```
Run a container using the built image:
```
docker run --network host jambo-web-api --rm
```
The `--network host` parameter is used to make the container share the host machine's network. This allows the container to directly access local services, such as the database.
The application will start and be accessible through `http://localhost:8080`.
## About EF Core
For in-depth information on Entity Framework Core concepts used in this project, please refer to the official Microsoft documentation:
[Conventions for relationship discovery](https://learn.microsoft.com/en-us/ef/core/modeling/relationships/conventions)
[Eager Loading of Related Data](https://learn.microsoft.com/en-us/ef/core/querying/related-data/eager)
[Shadow and Indexer Properties](https://learn.microsoft.com/en-us/ef/core/modeling/shadow-properties)