Skip to content

ipazanin/can-database

Repository files navigation

CAN database

Workflows

Workflow


Requirements:

  • Make
  • Docker
  • Docker Compose
  • .NET 5.0 SDK

Start Application

Application has mapped ports

  • 7000 for HTTP
  • 7001 for HTTPS
  • 1433 for Database

1. With Docker Compose

Start: make compose
Stop: make compose arg=down

2. .NET 5.0 Runtime

Start-Database: make compose-database
Stop-Database: make compose-database arg=down
Start-Server: make start
Stop-Server: ctrl+c

3. .NET 5.0 Runtime with watch for debugging

Start-Database: make compose-database
Stop-Database: make compose-database arg=down
Start-Server: make start arg=watch
Stop-Server: ctrl+c


Build Docker Image

Docker build latest version: make docker-build
Docker build some version: make docker-build v=1.0


Tests (Unit and Integration)

Run Tests: make test
Generate Code Coverage Report: make coverage

Generated Reports Are Located in TestReportsFolder Test Reports Location

Code Coverage Report can be viewed by navigating to TestReport Folder and opening index.html file with browser Code Coverage


Architecture

Logical Architecture:
Logical Architecture
Open API Documentation (Swagger) can be found at /docs address:
Swagger


Known Issues

Blazor Application is only served by server when environment variable ASPNETCORE_ENVIRONMENT
has value development (case invariant)
Github Issue


Tasks

Mandatory

  • Configure Dev Environment ✅
  • Add Project Backbone ✅
  • Create Domain Models From dbc-examples ✅
  • Configure Database ✅
  • Create Application Logic ✅
    • Add .dbc Parsing ✅
    • Add CRUD ✅
  • Add Application Infrastructure ✅
  • Add Web Api Infrastructure ✅
  • Create Web API Endpoints ✅
  • Configure Communication between Client And Server ✅
  • Create Client Application ✅
  • Add Docker and Docker Compose ✅
  • Add Integration Tests ✅
  • Write Detailed Documentation ✅

Optional

  • Add Unit Tests ✅
  • Add Github Workflow ✅
  • Add Code Coverage Reports ✅

Future Work

  • Separate Blazor Components Markup from Logic
  • Additional Unit and Integration Tests with at least 80% Code Coverage
  • Additional features

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published