gaepdit / gaepdit/caers-api

Plan project structure

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Draft Project Outline

* **Document Domain** - Entities representing JSON ReportInfo & EmissionsReport documents with metadata
* **Document Repository** - CRUD operations for JSON documents
* **CAERS Entity Domain** - ReportInfo & EmissionsReport objects with methods for parsing from JSON documents/elements
* **Entity Repository** for JSON SQL Server Queries?
* **API Service** - Authenticate and retrieve JSON documents from CAERS
* **App Service** -
- For a specific facility:
1. Load local ReportInfo document
2. Retrieve ReportInfo document from CAERS
3. Compare metadata
- Save latest ReportInfo if stale
4. Load local EmissionsReport if fresh
5. Otherwise, retrieve EmissionsReport from CAERS
- Save latest EmissionsReport if stale
6. Return result with ReportInfo & EmissionsReport documents
- For general data needs, run a service that retrieves all data on a schedule?
* **App** - discuss needs with ECSU
- Display current data for facility
- Search?
- Summarize?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the draft project outline and review how the proposed document domains, repositories, API service, app service, and app fit together. Discuss the app needs with ECSU; done means an agreed project structure and scope for the CAERS data retrieval, storage, comparison, and display workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, backend, database
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.