https://github.com/yelenasam/todoapp
TodoApp - Real-time Task Management (WPF + ASP.NET + SignalR)
https://github.com/yelenasam/todoapp
asp-net-core mssql mvvm rest-api signalr wpf
Last synced: 2 months ago
JSON representation
TodoApp - Real-time Task Management (WPF + ASP.NET + SignalR)
- Host: GitHub
- URL: https://github.com/yelenasam/todoapp
- Owner: yelenasam
- Created: 2025-05-24T10:05:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-03T09:26:45.000Z (11 months ago)
- Last Synced: 2025-10-07T20:47:21.482Z (9 months ago)
- Topics: asp-net-core, mssql, mvvm, rest-api, signalr, wpf
- Language: C#
- Homepage:
- Size: 944 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TodoApp – Real-Time Synchronized To-Do List
> **Tech stack:** WPF (.NET 8) • ASP.NET Core 8 Web API • SignalR • SQL Server • EF Core 8
---
## 1 · Architecture Overview
### Use-Case Diagram
### Logical Components
| Tier | Technology | Responsibility |
|-------------|---------------------------|-------------------------------------------------|
| **Client** | WPF + MVVM | UI, state, commands |
| **Server** | ASP.NET Core API + SignalR| CRUD + real-time broadcast + business rules |
| **Data** | SQL Server + EF Core 8 | Persistence, migrations, transactions |
---
## 2 · Communication Protocol
| Channel | reasoning |
|---------|---------------------|
| **HTTPS REST API** | Ideal for CRUD – stateless, cacheable, discoverable via Swagger / Postman. Can be secured later with cookies or bearer tokens. |
| **SignalR (WebSocket)** | Real-time events: `TaskAdded`, `TaskUpdated`, `TaskDeleted`, `TaskLocked`, `TaskUnlocked`.
Keeps every client in sync without polling, minimises traffic, auto-reconnects.
Has built-in scalability, simplicity of use, and easy integration with .NET ecosystems. |
---
### Edit and Update Sequence Diagram
---
### 2.1 · REST Endpoints
| HTTP Verb | URL | Payload / Params | Purpose |
|-----------|------------------------------------|-------------------------|---------------------------------------|
| **GET** | `/api/tasks` | – | Retrieve all tasks |
| **POST** | `/api/tasks` | `TaskItem` JSON | Add new task |
| **PUT** | `/api/tasks/{id}` | `TaskItem` JSON | Update entire task |
| **DELETE**| `/api/tasks/{id}` | `"task id"` (int) | Delete task |
| **POST** | `/api/tasks/{id}/lock` | `"task id"` (int) | Lock task for editing |
| **POST** | `/api/tasks/{id}/unlock` | `"task id"` (int) | Unlock task |
| **PUT** | `/api/tasks/{id}/complete` | `"task id"` (int), `iscompleted` JSON | Set completion state |
| **GET** | `/api/users` | – | List users (mock auth/demo) |
| **GET** | `/api/tags` | – | List available tags |
---
## 3 · Design Patterns
| Pattern | In Code | Benefit |
|---------|---------|---------|
| **MVVM** | `TasksViewModel`, etc. | Testable UI, clear separation, data binding. |
| **Repository + Unit of Work** | `TaskItemsService` ⇢ `TodoDbContext` | Single gateway to DB; one atomic transaction per request. |
| **Pub/Sub** | SignalR hub | Decoupled event distribution to all clients. |
| **Singleton** | `ErrorHandler` | One global policy for logging & user feedback. |
| **Dependency Injection** | Built-in DI, WPF ServiceCollection | Loose coupling, easy mocking. |
| **Observer** | `INotifyPropertyChanged`, `ObservableCollection` | Automatic UI refresh when data changes. |
---
## 4 · Prerequisites
* .NET 8 SDK
* SQL Server / Express / LocalDB
* Visual Studio 2022 (17.8+) or VS Code
* Git
## 5. Setup
### 5.1 Clone & prerequisites
```bash
git clone https://github.com/yelenasam/TodoApp.git
cd TodoApp
```
### 5.2 Trust the local HTTPS dev-certificate (one-time)
```bash
dotnet dev-certs https --trust
```
### 5.3 Create the database
```bash
# applies EF Core 8 migrations
dotnet ef database update -p TodoApp.Server
```
### 5.4 Run the back-end
```bash
dotnet run --project TodoApp.Server --launch-profile https
# Now listening on:
# https://localhost:7186
# http://localhost:5097
```
> Open https://localhost:7186/swagger to test the API.
### 5.5 Run the WPF client in a second terminal
```bash
dotnet run --project TodoApp.Client
```
---
## 6 TodoApp running:
### 6.1. Login View:
---
### 6.2. Tasks View:
The Tasks view displays the all tasks table and selected or new task details.
All tasks that are locked by someone else will be colored in grey, and all the tasks locked by the user will be green.
---
### Selected task locked by someone else:
---
### Selected task locked by the user:
---
### Creating New Task:
---
### 6.3. Swagger:
---