Skip to content

Docs: remove project structure section from README #19

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
joeldickson merged 7 commits into from
Mar 26, 2026
Merged

Docs: remove project structure section from README #19

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a2acb70
Docs: remove project structure section from README
joel Mar 26, 2026
9f1bac8
Docs: remove ingest endpoints and PostgreSQL MVP migration notes
joel Mar 26, 2026
13d058b
Docs: remove dashboard pages section from README
joel Mar 26, 2026
81850bd
Docs: expand local Vite proxy explanation and add blog link
joel Mar 26, 2026
1e99d86
Docs: remove CI/CD section and link to specific Vite + .NET BFF post
joel Mar 26, 2026
e3d2c27
Docs: remove extended local-development proxy paragraph
joel Mar 26, 2026
0623a77
Docs: keep specific Vite + .NET BFF blog link sentence
joel Mar 26, 2026
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
46 changes: 2 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,6 @@ This is an internal tool designed to be deployed within your organization's infr
- **Frontend:** React 19, TypeScript, Vite 8, Tailwind CSS 3, Tremor, Recharts
- **Container:** Docker image available at `agoda/devex-telemetry`

## Project Structure

```text
src/
├── Agoda.DevExTelemetry.WebApi/ # ASP.NET Core API (controllers, Program.cs)
├── Agoda.DevExTelemetry.Core/ # Domain layer (entities, DTOs, services, DbContext)
├── Agoda.DevExTelemetry.IntegrationTests/
├── Agoda.DevExTelemetry.UnitTests/
├── Clientside/ # React SPA (Vite + Tailwind + Tremor)
└── Agoda.DevExTelemetry.sln
```

## Telemetry Clients

These are the client libraries that instrument developer tooling and send telemetry to this server:
Expand All @@ -45,27 +33,6 @@ These are the client libraries that instrument developer tooling and send teleme
| Jest reporter | npm | `POST /jest` | [testresults-collector](https://github.com/agoda-com/testresults-collector) |
| Vitest reporter | npm | `POST /vitest` | [testresults-collector](https://github.com/agoda-com/testresults-collector) |

## Ingest Endpoints

| Endpoint | Payload Type |
|---|---|
| `POST /dotnet` | .NET MSBuild compile, ASP.NET startup, first response |
| `POST /dotnet/nunit` | NUnit / xUnit test results |
| `POST /junit` | JUnit test results |
| `POST /jest` | Jest test results |
| `POST /vitest` | Vitest test results |
| `POST /scala/scalatest` | ScalaTest results (gzip supported) |
| `POST /webpack` | Webpack build metrics |
| `POST /vite` | Vite build / HMR metrics |
| `POST /gradletalaiot` | Gradle Talaiot build metrics |
| `POST /testdata/junit` | JUnit XML multipart upload |

## Dashboard Pages

- **Test Run Performance** — pass rates, durations, per-test-case drill-down
- **API Build Performance** — compile, startup, and first response times
- **Clientside Build Performance** — hot reload vs full build metrics

## PostgreSQL Support

The API supports PostgreSQL when `POSTGRES_CONNECTION_STRING` is provided.
Expand All @@ -76,8 +43,6 @@ export POSTGRES_CONNECTION_STRING='Host=localhost;Port=5432;Database=devex_telem

Notes:
- If `POSTGRES_CONNECTION_STRING` is not set, the app uses SQLite.
- Current PostgreSQL initialization uses `EnsureCreated()` as an MVP path.
- For long-term schema evolution, move to dedicated PostgreSQL migrations and `db.Database.Migrate()`.

## Docker Usage

Expand Down Expand Up @@ -151,18 +116,11 @@ npm run dev

The dev server starts at `http://localhost:5173` and proxies `/api` requests to the backend.

I wrote more about this exact setup in [Bridging Worlds: Making .NET BFF and React/Vite Play Nice in Development](https://medium.com/beer-and-servers-dont-mix/bridging-worlds-making-net-bff-and-react-vite-play-nice-in-development-b0f7b9311790).

### Running Tests

```bash
cd src
dotnet test
```

## CI/CD

Pushes to `main` trigger automatic deployment to Azure App Service via GitHub Actions.

| Workflow | Trigger | Purpose |
|---|---|---|
| `build.yml` | Pull requests to main | Build + test validation |
| `deploy.yml` | Push to main | Build + deploy to Azure |
Loading