BSA 2023 | .NET | Squirrel

Technologies:

Backend:

• Platform: .NET 6
• Network: REST, SignalR, RabbitMQ
• Database: MS SQL Server, Entity Framework Core
• Cloud: Azure
• Other: JWT, Docker

Frontend:

• Angular
• MaterialUI
• RxJS
• HTML5/CSS3/SASS

Links:

• Trello Board

Building sources

By default, apps run on the following ports:

Application	Port
Squirrel.Core	5050
Squirrel.Notifier	5070
RabbitMQ	5672

Tip: If you want to connect to the specific service outside of docker, then use "localhost" as a service name, but if both services are inside docker, use service_name from a "docker-compose" file instead.

Code quality

Make sure you read and follow .NET Quality Criteria. Also, there are some best practices for frontend development: Angular and Typescript

Docker:

1. Make sure you have Docker and Docker Compose.
2. Pull this repo to your machine.
3. You can build and run all application containers via docker-compose -f docker-compose.apps.yml up -d command.
4. You can pull and run all 3rd-party services (MSSQL Server, RabbitMQ) via docker-compose -f docker-compose.services.yml up -d command.
5. Happy coding! 😎

Setup environment for local development:

1. Download and install .NET 6 SDK.
2. It might be useful to have EF CLI. Install via command: dotnet tool install --global dotnet-ef
3. Download and install LTS version of Node.js
4. Install Angular-CLI via: npm install -g @angular/cli. What is Angular-CLI?

Extensions for frontend development (required):

• ESLint (analysis tool that checks TypeScript\JavaScript code for readability, maintainability, and functionality errors)
• EditorConfig (helps maintain consistent coding styles for multiple developers working on the same project)

Some extra extensions which can significantly help to work with Angular:

• Angular Language Service (intelliSense for Angular templates)
• Angular Snippets
• Angular Schematics (working with Angular schematics via UI)

Environment variables

This is a list of the required environment variables:

RabbitMQ

RABBIT_MQ_USERNAME - RabbitMQ username

RABBIT_MQ_PASSWORD - RabbitMQ user password

MSSQL Server

SA_PASSWORD - MSSQL Server "SA" user password

SQL Server Database Schema

erDiagram

    UserProjects {
        int Id PK
        int ProjectId FK
        int UserId FK
        int RoleEnum
    }

    Users {
        int Id PK
        nvarchar(25) UserName
        nvarchar(25) FirstName
        nvarchar(25) LastName
        nvarchar(50) Email
        nvarchar(500) Salt
        nvarchar(500) PasswordHash
        nvarchar(500) AvatarUrl
    }

    RefreshTokens {
        bigint Id PK
        int UserId FK
        nvarchar(500) Token
        datetime CreatedAt
    }

    Commits {
        int Id PK
        int AuthorId FK
        nvarchar(200) Message 
        datetime CreatedAt 
    }

    Projects {
        int Id PK
        int DefaultBranchId FK
        nvarchar(50) Name
        int EngineEnum
    }

    BranchCommits {
        int Id PK
        int BranchId FK
        int CommitId FK
        bit IsMerged 
        bit IsHead 
    }

    CommitParents {
        int Id PK
        int CommitId FK
        int ParentId FK
    }

    CommitFiles {
        int Id PK
        int CommitId FK
        nvarchar(100) FileName
        int FileTypeEnum
        nvarchar(100) BlobId
    }

    ProjectTags {
        int Id PK
        int TagId FK
        int ProjectId FK
    }

    Tags {
        int Id PK
        nvarchar(50) Name    
    }

    Branches {
        int Id PK
        int ProjectId FK
        nvarchar(200) Name 
        bit IsActive 
    }

    PullRequests {
        int Id PK
        int ProjectId FK
        int AuthorId FK
        int SourceBranchId FK
        int TargetBranchId FK
        nvarchar(100) Title 
        int StatusEnum 
        bit IsReviewed 
        datetime CreatedAt 
        datetime UpdatedAt 
    }

    PullRequestReviewers {
        int Id PK
        int PullRequestId FK
        int UserId FK
    }

    Comments {
        int Id PK
        int AuthorId FK
        nvarchar(500) Content 
        datetime CreatedAt 
        datetime UpdatedAt 
        int CommentedEntityId  
        int CommentedEntityTypeEnum
    }


Users ||--|{ UserProjects : ""
Users ||--|{ RefreshTokens : ""
Users ||--|{ Commits : ""
Users ||--|{ PullRequests : ""
Users ||--|{ PullRequestReviewers : ""
Users ||--|{ Comments : ""

Commits ||--|{ CommitParents : ""
Commits ||--|{ CommitFiles : ""
Commits ||--|{ BranchCommits : ""

Projects ||--|{ UserProjects : ""
Projects ||--|{ ProjectTags : ""
Projects ||--|{ Branches : ""
Projects ||--|| Branches : ""
Projects ||--|{ PullRequests : ""

Branches ||--|{ BranchCommits : ""
Branches ||--|{ PullRequests : ""

PullRequests ||--|{ PullRequestReviewers : ""

Tags ||--|{ ProjectTags : ""