Skip to content

Revise README for tech stack and deployment updates #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mike014 merged 1 commit into from
Jun 8, 2026
Merged

Revise README for tech stack and deployment updates #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 34 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Nexus Engine

![CI](https://github.com/Mike014/Nexus-Engine/actions/workflows/ci.yml/badge.svg)

<div align="center">
<img src="assets/images/logo.jpg" alt="Nexus Engine"
alt="Nexus Engine"
Expand Down Expand Up @@ -74,8 +76,8 @@ Nexus Engine is not a commercial product. It is a technical portfolio project th
## Tech Stack

### Backend
- ASP.NET Core 8 Web API
- Entity Framework Core 8 + Npgsql
- ASP.NET Core 9 Web API
- Entity Framework Core 9 + Npgsql
- MediatR 12 (CQRS)
- SignalR (real-time WebSocket)
- Swashbuckle (Swagger UI)
Expand Down Expand Up @@ -110,8 +112,17 @@ cd Nexus-Engine
docker compose --profile csharp up --build
```

### Workflow

```bash
git checkout -b fix/name
git add .
git commit -m "fix: "
git push origin fix/nameix
### Available endpoints
```

### HTTP Requests
```
POST /api/accounts Create a new account
GET /api/accounts/{id} Get current account state (from projection)
Expand Down Expand Up @@ -150,6 +161,18 @@ restart with an empty state.

---

## Live Demo

| Service | URL |
|---------|-----|
| Frontend | https://nexus-engine-olive.vercel.app |
| Backend API | https://nexus-engine-production-60c8.up.railway.app |
| Swagger UI | https://nexus-engine-production-60c8.up.railway.app/swagger |
| Health Live | https://nexus-engine-production-60c8.up.railway.app/health/live |
| Health Ready | https://nexus-engine-production-60c8.up.railway.app/health/ready |

---

## Architectural Decisions

### ADR-001: Event Sourcing as persistence strategy
Expand Down Expand Up @@ -212,14 +235,15 @@ Handlers depend on `INexusUnitOfWork` interface, never on `NexusDbContext` direc
- 20/20 unit tests passing (xUnit + Moq)
- Selenium E2E test: full buy/sell match flow verified

### Phase 5 — Observability and Deploy
- Structured logging (Serilog)
- Health checks
- MediatR Pipeline Behavior for global exception handling
- Architecture diagrams and ADR documentation
- Deploy to Railway (PostgreSQL + backend + frontend)
- Public URL for portfolio showcase
- Metrics (Prometheus + Grafana, optional)
### Phase 5 — Observability and Deploy ✅
- Structured logging (Serilog) with Console + File sinks
- Health checks (/health/live and /health/ready)
- MediatR Pipeline Behavior (LoggingBehavior)
- Deploy to Railway (PostgreSQL + ASP.NET Core 9 backend)
- Deploy to Vercel (React/Vite frontend)
- Public URLs for portfolio showcase
- GitHub Actions CI (build + 20 tests on every PR)
- Branch protection on main (PR required, CI must pass)

---

Expand Down
Loading