Skip to content

Latest commit

 

History

History
104 lines (95 loc) · 5.19 KB

README.md

File metadata and controls

104 lines (95 loc) · 5.19 KB
Raw

TODOtNET - ASP.NET Core hosted full-stack C# single-page web application with Blazor Webassembly

Table of Content

  1. Introduction
  2. Used SDK version
  3. Used tools
  4. Used packages
  5. How to run the app
    5.1. Build and run with Docker
    5.2. Build and run with SDK
    5.3. Test and stop
  6. Limitations
    7.1. Exception/error handling
  7. Some further development possibilities
  8. Resources

1. Introduction

This is a basic ASP.NET Core hosted SPA using Blazor Webassembly with CRUD operations and user login/account management. You can register a new user account with your email address, name and password. After successful registration, you can log in and add, edit, remove and track TODO items. You can also edit your account data and delete your account. This app was created for learning purpose, but is might be useful as a starting-point for other projects.

The backend uses:

  • JWT for authentication
  • Entity Core as ORM
  • Identity Core for identity management
  • SQLite for DB management

The frontend uses:

  • Blazor Webassembly
  • Bootstrap

Tooling:

  • Git Extensions as git gui
  • VSC as text editor
  • Docker for containerization
  • Windows 10 as OS

If any question, please do not hesitate to contact me.

2. Used SDK version

.NET Core SDK v3.1.301

3. Used tools

  • dotnet-ef
  • dotnet-aspnet-codegenerator

4. Used packages

Backend:

  • Microsoft.AspNetCore.Authentication.JwtBearer v3.1.3
  • Microsoft.AspNetCore.Identity v2.2.0
  • Microsoft.AspNetCore.Identity.EntityFrameworkCore v3.1.3
  • Microsoft.AspNetCore.Mvc.NewtonsoftJson v3.1.3
  • Microsoft.EntityFrameworkCore.Design v3.1.2
  • Microsoft.EntityFrameworkCore.SQLite v3.1.2
  • Microsoft.EntityFrameworkCore.SqlServer v3.1.2
  • Microsoft.IdentityModel.Tokens v6.5.0
  • Microsoft.VisualStudio.Web.CodeGeneration.Design v3.1.1
  • Microsoft.AspNetCore.Components.WebAssembly.Server 3.2.0
  • AutoMapper.Extensions.Microsoft.DependencyInjection v7.0.0

Frontend:

  • Microsoft.AspNetCore.Components.Authorization v3.1.4
  • Microsoft.AspNetCore.Components.WebAssembly v3.2.0
  • Microsoft.AspNetCore.Components.WebAssembly.Build v3.2.0
  • Microsoft.AspNetCore.Components.WebAssembly.DevServer v3.2.0
  • System.Net.Http.Json v3.2.0

Shared:

  • System.ComponentModel.Annotations v4.7.0

5. How to run the API

5.1. Build and run with Docker

  • download and install Docker
  • clone or download the content of the repository
  • open a terminal and navigate to the containing folder
  • write "docker build -t todowebapp:v1 ." and press Enter
  • write "docker run -it --rm -p 5000:5000 todowebapp:v1" and press Enter

5.2. Build and run with SDK

  • download and install .NET Core SDK version v3.1.301 or greater (latest 3.1)
  • clone or download the content of the repository
  • open a terminal and navigate to the containing folder
  • write "dotnet restore" and press Enter
  • navigate to folder Server
  • write "dotnet run" and press Enter

5.3. Test and stop

  • if no error message in the terminal, open your browser (recommended: latest Chrome, Firefox, Safari, Edge Chromium or Chromium) and open: http://localhost:5000
  • first register a user account, then log in and after that you can manage your TODO items and account
  • after testing go back to the terminal and press "Ctrl+C" to stop the web server

6. Limitations

6.1. Exception/error handling

This application needs to be extended with exception handling and more response values. There are some already known issues which may cause error when it is not used correctly. I only tested the app with correct input values.

7. Some further development possibilities

  • token refreshing
  • Facebook sign-in
  • adding roles (admin, user)
  • OpenID Connect & IdentityServer4
  • automated unit and integration tests

8. Resources

There are several online source which I used for creating this web app. I reused my TODOtNET_API RESTful API project as a backend for this application. All the resources that are listed in the README.md at that repo applies here as well.
Blazor resource - Including but not limited to:

Thank to every hero on Stackoverflow and Github who helped me with their comments! (Not all heroes wear capes.)