BugLab

A bug/issue tracker with .Net 5 using Blazor WASM and Web API that can be used internally to manage different projects and see what needs to be done. It started out with only the necessary features and code in order to practice a more Agile approach and lots of refactoring.

Images

Sprints page (new!)

Login page

Home page

My projects page

My Bugs page

Add a new bug or a bug type to a project

Give a user access to a project

What this project has/makes use of

Blazor

• Mudblazor - instead of bootstrap, let's us focus more on code and less on design/reponsivness
• Authorization with JWT tokens

API

• EF core, audit tracking, SQL server
• Authentication and Authorization using ASP identity and JWT tokens including refresh tokens
• CQRS with MediatR - SRP and maintainability. Has a auto caching pipeline behavior for queries implementing ICacheable such as the ProjectUsersQuery which are fetched many times but not changed as often
• Mapster - a faster mapper
• Fluentvalidation - Clean validation instead of polluting models with data annotations
• Pagination
• DTO's - models for transfering data
• Multi/N-tier architecture
• Background services
• Mailkit for modern mailing

Test

• Fluentassertions - asserts with better error logs
• EFcore Test Support - creates a in memory sqlite database
• Moq for focused tests

Contributions are highly appreciated!

• Open up an issue for whatever you think should be implemented and is necessary for this type of project

• Include as much information as possible in the issue, such as why this needs to be added/fixed.

• Name your branch depending on what type of issue it is, is it a feature then use feature/[issueNumber]-[title]

• Try to follow the already existing design in order to be consistent, but if you think that something could be done in a better way I would love to take a look at that approach

• There are no dumb questions! feel free to message on discord ChrisK#8272

Using the project

• The app uses a local connection string SQL server connection string so you don't have to deal with that part and the token key is just a hard coded string in appsettings. You just need to run update-database so that the database gets created
• You need an account that can be used for mailing, I prefer etheral which generates an account for you and will send all emails to the created account. Then you can configure the options inside user secrets for the Email options (right click the API project and then manage user secrets).

"EmailOptions": {
    "Port": 587,
    "Host": "smtp.ethereal.email",
    "Password": "yourPassword",
    "From": "[email protected]",
    "Name": "your friendly neighbor"
  }

• Right click the solution and press properties, then select multiple startup projects. After that you can choose to have BugLab.Blazor and BugLab.API to start when you run the app

Here are some things Todo:

• You could refactor the commands/queries to become records instead, then you would have a Commands folder, with feature by folder, then a file with all the Commands for that feature and your handler files: Commands/Bugs/ in this folder we can find BugCommands.cs, AddBugHandler, DeleteBugHandler etc.... If you do this then you need to create a PaginationParams record we can inherit from, I normally choose composition over inheritence but in this app we wont inherit from something else and it's more convenient to do request.PageNumber over request.PaginationParams.PageNumber.
• I'm not a front-end designer and my focus is not on the design but rather functionality so feel free to improve it and accessibility
• Integration tests and more unit tests!
• Attachments (f.e image, gif) - a perfect usecase for cloudinary
• Client side refactoring, there is a bunch of code that could either be moved to a partial class (code behind file), to a service (make it reusable) or a component
• Background service that sends a weekly stats mail regarding for example the project with most completed bugs, the project with most high prioritized bugs, how many bugs you have completed
• The idea is that we give all users in a project read/write permissions to all items. If you are a performance freak you could change our urls to almost always start with projects/projectId f.e getting a comment would then be projects/projectId/bugs/bugId/comments/id, not the fanciest but since we don't need to fetch the bug in order to get the projectId to see if the user is in it we boost performance a bit but as i said there's no point in changing the code base for a little performance boost unless necessary. One great point is that it makes accessing items in the Api consistent but it also means that we need two endpoints for getting bugs. right now: api/bugs - my bugs and api/bugs?projectId=1 - project's bugs VS api/users/1/bugs and api/projects/1/bugs