Skip to content

README.md

Latest commit

 

History

History
61 lines (40 loc) · 1.93 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.93 KB

Industrial Telemetry API

This repository contains a recruiter-friendly, sanitized edition of a real-world industrial telemetry backend.

Ownership and Delivery

This project was built entirely by me and delivered to a Swedish client within 2 weeks.

What This Project Demonstrates

  • Building a versioned REST API with NestJS
  • Designing telemetry-oriented data access for time-series workloads
  • Structuring modules for mills/sites, tags, metadata, control values, and historical values
  • Handling pagination, date filtering, and aggregation endpoints

Privacy and Publishing Changes

To make this project safe for public sharing, this edition intentionally removes or anonymizes sensitive assets:

  • Internal cloud infrastructure definitions
  • CI/CD files tied to private subscriptions/service connections
  • Organization-specific documentation and identifiers
  • Large raw data exports and historical data dumps

Repository Layout

  • data-api/: NestJS API application
  • db-schema/: SQL schema and synthetic seed examples
  • testdata/: Synthetic JSON payload samples

Run Locally

cd data-api
npm install
cp .env.example .env
npm run start:dev

Default URL: http://localhost:3001

Swagger UI: http://localhost:3001/api

API Prefix

  • Local app prefix: /processhistorydata
  • Azure bootstrap prefix in source: /api/processhistorydata/v1

Portfolio Positioning

Use this repository to showcase backend architecture, API design, and practical engineering tradeoffs. Pair it with a short case-study in your CV or LinkedIn project description describing:

  1. Problem domain
  2. Your technical decisions
  3. Performance/reliability considerations
  4. What was removed or anonymized for privacy

Publishing Safety Note

Sensitive files were removed from the current working tree, but they can still exist in old git commits.
For public release, publish from a fresh repository history (recommended) or rewrite history before pushing.