CouncilDataProject / CouncilDataProject/cdp-backend

Dynamically Generate TypeScript DB Models, Transcript Model, and other Constants

オープン
#167 コメント 15 件 リアクション 1 件 担当者 0 名 GitHub で見る
enhancement good first issue help wanted infrastructure
主要言語
Python
スター
25
フォーク
28
PR マージ指標
30日以内にマージされた PR はありません

説明

## Idea / Feature

Dynamically generate TypeScript object definitions from `cdp-backend` Python DB models.

## Use Case / User Story

As a developer I want to be able to add, remove, or update a database model in a single location rather than multiple.

## Solution

Add a script to `cdp-backend` that when ran will generate a TypeScript package of the database models + extras that we can push to npm on new version push.

## Alternatives

## Stakeholders

Backend maintainers
Frontend maintainers

## Major Components

* [ ] Database models TypeScript generation
* [ ] Transcript File Model TypeScript generation
* [ ] Database "ModelField" Python and TypeScript generation
* [ ] Database constants TypeScript generation
* [ ] script added as bin script to `cdp-backend`
* [ ] task added to CI building and testing that attempts to generate these models on PR push / main build
* [ ] task added to CI main building / publish job that pushes the generated TypeScript package dir to npm

## Dependencies

## Other Notes

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

特定のファイルやテストは指定されていません。まず、Pythonデータベースモデル、cdp-backend bin-scriptエントリポイント、CIのビルドおよび公開ジョブを見つけます。生成されたTypeScriptモデルと定数がビルドでテストされ、パッケージが指定どおりに公開されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python, typescript
領域
backend, build-system, ci-cd, databases, release
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。